diff --git a/Documentation/Documentation-Contents.md b/Documentation/Documentation-Contents.md index 4906c0e19..abe13029e 100644 --- a/Documentation/Documentation-Contents.md +++ b/Documentation/Documentation-Contents.md @@ -105,6 +105,7 @@ Module specific documentation. - [Galera Monitor](Monitors/Galera-Monitor.md) - [ColumnStore Monitor](Monitors/ColumnStore-Monitor.md) - [Aurora Monitor](Monitors/Aurora-Monitor.md) + - [Clustrix Monitor](Monitors/Clustrix-Monitor.md) Legacy monitors that have been deprecated. diff --git a/Documentation/Monitors/Clustrix-Monitor.md b/Documentation/Monitors/Clustrix-Monitor.md new file mode 100644 index 000000000..4569b6046 --- /dev/null +++ b/Documentation/Monitors/Clustrix-Monitor.md @@ -0,0 +1,48 @@ +# Clustrix Monitor + +## Overview + +The Clustrix Monitor is a monitor that monitors a Clustrix cluster. It is +capable of detecting the cluster setup and creating corresponding server +instances within MaxScale. + +## Configuration + +A minimal configuration for a monitor requires one server in the Clustrix +cluster, and a username and a password to connect to the server. Note that +the Clustrix monitor will only use that server in order to dynamically find +out the configuration of the cluster; after startup it will completely rely +upon information obtained at runtime. + +To ensure that the Clustrix monitor will be able to start, it is adviseable +to provide _more_ than one server to cater for the case that not all nodes +are always up when MaxScale starts. + +``` +[TheClustrixMonitor] +type=monitor +module=clustrixmon +servers=server1,server2,server3 +user=myuser +password=mypwd + +``` + +## Common Monitor Parameters + +For a list of optional parameters that all monitors support, read the +[Monitor Common](Monitor-Common.md) document. + +## Clustrix Monitor optional parameters + +These are optional parameters specific to the Galera Monitor. + +### `cluster_monitor_interval` + +Defines, in milliseconds, how often the monitor checks the state of the +entire cluster. The default value is 60000 (1 minute), which should not +be lowered as that may have an adverse effect on the Cluster itself. + +``` +cluster_monitor_interval=120000 +```