Added Galera monitor documentation.

This commit is contained in:
Markus Makela
2015-05-11 06:45:37 +03:00
parent 1d0740c1c1
commit 8f019b4514
2 changed files with 133 additions and 5 deletions

View File

@ -2,11 +2,11 @@
## Overview
The MySQL monitor is a monitoring module for MaxScale that monitors a Master-Slave replication cluster. It assigns master and slave roles inside MaxScale according to the acutal replication tree in the cluster.
The MySQL Monitor is a monitoring module for MaxScale that monitors a Master-Slave replication cluster. It assigns master and slave roles inside MaxScale according to the acutal replication tree in the cluster.
## Configuration
A minimal configuration of the MySQL monitor requires a set of servers for monitoring and a username and a password to connect to these servers. The user requires the REPLICATION CLIENT privilege to successfully monitor the state of the servers.
A minimal configuration for a monitor requires a set of servers for monitoring and a username and a password to connect to these servers. The user requires the REPLICATION CLIENT privilege to successfully monitor the state of the servers.
```
[MySQL Monitor]
@ -18,9 +18,9 @@ passwd=mypwd
```
## Optional parameters
## Optional parameters for all monitors
Here are optional parameters for the MySQL monitor that change the way it behaves.
Here are optional parameters that are common for all the monitors.
### `monitor_interval`
@ -54,6 +54,10 @@ This parameter controls the timeout for reading from a monitored server. It is i
backend_read_timeout=2
```
## MySQL Monitor optional parameters
These are optional parameters specific to the MySQL Monitor.
### `detect_replication_lag`
Detect replication lag between the master and the slaves. This allows the routers to route read queries to only slaves that are up to date.
@ -86,7 +90,7 @@ This script will be called with the following command line arguments.
```
<name of the script> --event=<event type> --initiator=<server whose state changed> --nodelist=<list of all servers>
```
Here is a table of all possible event names and their descriptions.
Here is a table of all possible event types and their descriptions.
Event Name|Description
----------|----------