[MXS-2792] Documentation for MaxScale's monitor script is incomplete Created: 2019-12-09 Updated: 2020-01-08 Resolved: 2020-01-08 |
|
| Status: | Closed |
| Project: | MariaDB MaxScale |
| Component/s: | Documentation, Monitor |
| Affects Version/s: | 2.3.15, 2.4.4 |
| Fix Version/s: | 2.3.16, 2.4.6 |
| Type: | Bug | Priority: | Major |
| Reporter: | Geoff Montee (Inactive) | Assignee: | Esa Korhonen |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Issue Links: |
|
||||||||||||||||
| Sprint: | MXS-SPRINT-96, MXS-SPRINT-97 | ||||||||||||||||
| Description |
|
The documentation for MaxScale's monitor script seems to be incomplete: https://mariadb.com/kb/en/mariadb-maxscale-24-common-monitor-parameters/#script https://mariadb.com/kb/en/mariadb-maxscale-23-common-monitor-parameters/#script It is missing the following items: 1.) It is missing the $CREDENTIALS argument: https://github.com/mariadb-corporation/MaxScale/blob/maxscale-2.4.4/server/core/monitor.cc#L1086 2.) It is missing a working example script: The MariaDB Monitor page for MaxScale 2.3 currently has an example script: https://mariadb.com/kb/en/mariadb-maxscale-23-mariadb-monitor/#example-1-monitor-script However, this script doesn't even work. It results in an error like this:
We should probably add a working example to the "Common Monitor Parameters" page. For example, if we had the following monitor configured:
Then the following script makes a good example:
|