From 09ae26d7c951df67e706c4fe520f31ceb3409fe0 Mon Sep 17 00:00:00 2001 From: Markus Makela Date: Thu, 10 Dec 2015 14:32:10 +0200 Subject: [PATCH] Moved common monitor options to Monitor-Common.md --- Documentation/Monitors/Galera-Monitor.md | 36 ++----------------- Documentation/Monitors/MM-Monitor.md | 36 ++----------------- Documentation/Monitors/Monitor-Common.md | 32 +++++++++++++++++ Documentation/Monitors/MySQL-Monitor.md | 36 ++----------------- Documentation/Monitors/NDB-Cluster-Monitor.md | 36 ------------------- 5 files changed, 38 insertions(+), 138 deletions(-) diff --git a/Documentation/Monitors/Galera-Monitor.md b/Documentation/Monitors/Galera-Monitor.md index e91373297..57cbf88b8 100644 --- a/Documentation/Monitors/Galera-Monitor.md +++ b/Documentation/Monitors/Galera-Monitor.md @@ -18,41 +18,9 @@ passwd=mypwd ``` -## Optional parameters for all monitors +## Common Monitor Parameters -Here are optional parameters that are common for all the monitors. - -### `monitor_interval` - -This is the time the monitor waits between each cycle of monitoring. The default value of 10000 milliseconds (10 seconds) should be lowered if you want a faster response to changes in the server states. The value is defined in milliseconds and the smallest possible value is 100 milliseconds. - -``` -monitor_interval=2500 -``` - -### `backend_connect_timeout` - -This parameter controls the timeout for connecting to a monitored server. It is in seconds and the minimum value is 1 second. The default value for this parameter is 3 seconds. - -``` -backend_connect_timeout=6 -``` - -### `backend_write_timeout` - -This parameter controls the timeout for writing to a monitored server. It is in seconds and the minimum value is 1 second. The default value for this parameter is 2 seconds. - -``` -backend_write_timeout=4 -``` - -### `backend_read_timeout` - -This parameter controls the timeout for reading from a monitored server. It is in seconds and the minimum value is 1 second. The default value for this parameter is 1 seconds. - -``` -backend_read_timeout=2 -``` +For a list of optional parameters that all monitors support, read the [Monitor Common](Monitor-Common.md) document. ## Galera Monitor optional parameters diff --git a/Documentation/Monitors/MM-Monitor.md b/Documentation/Monitors/MM-Monitor.md index a90d2bf71..2c51814d0 100644 --- a/Documentation/Monitors/MM-Monitor.md +++ b/Documentation/Monitors/MM-Monitor.md @@ -18,41 +18,9 @@ passwd=mypwd ``` -## Optional parameters for all monitors +## Common Monitor Parameters -Here are optional parameters that are common for all the monitors. - -### `monitor_interval` - -This is the time the monitor waits between each cycle of monitoring. The default value of 10000 milliseconds (10 seconds) should be lowered if you want a faster response to changes in the server states. The value is defined in milliseconds and the smallest possible value is 100 milliseconds. - -``` -monitor_interval=2500 -``` - -### `backend_connect_timeout` - -This parameter controls the timeout for connecting to a monitored server. It is in seconds and the minimum value is 1 second. The default value for this parameter is 3 seconds. - -``` -backend_connect_timeout=6 -``` - -### `backend_write_timeout` - -This parameter controls the timeout for writing to a monitored server. It is in seconds and the minimum value is 1 second. The default value for this parameter is 2 seconds. - -``` -backend_write_timeout=4 -``` - -### `backend_read_timeout` - -This parameter controls the timeout for reading from a monitored server. It is in seconds and the minimum value is 1 second. The default value for this parameter is 1 seconds. - -``` -backend_read_timeout=2 -``` +For a list of optional parameters that all monitors support, read the [Monitor Common](Monitor-Common.md) document. ## Multi-Master Monitor optional parameters diff --git a/Documentation/Monitors/Monitor-Common.md b/Documentation/Monitors/Monitor-Common.md index 1d27dc419..eb89805b3 100644 --- a/Documentation/Monitors/Monitor-Common.md +++ b/Documentation/Monitors/Monitor-Common.md @@ -4,6 +4,38 @@ This document lists optional parameters that all current monitors support. ## Parameters +### `monitor_interval` + +This is the time the monitor waits between each cycle of monitoring. The default value of 10000 milliseconds (10 seconds) should be lowered if you want a faster response to changes in the server states. The value is defined in milliseconds and the smallest possible value is 100 milliseconds. + +``` +monitor_interval=2500 +``` + +### `backend_connect_timeout` + +This parameter controls the timeout for connecting to a monitored server. It is in seconds and the minimum value is 1 second. The default value for this parameter is 3 seconds. + +``` +backend_connect_timeout=6 +``` + +### `backend_write_timeout` + +This parameter controls the timeout for writing to a monitored server. It is in seconds and the minimum value is 1 second. The default value for this parameter is 2 seconds. + +``` +backend_write_timeout=4 +``` + +### `backend_read_timeout` + +This parameter controls the timeout for reading from a monitored server. It is in seconds and the minimum value is 1 second. The default value for this parameter is 1 seconds. + +``` +backend_read_timeout=2 +``` + ### `script` This command will be executed when a server changes its state. The parameter should be an absolute path to a command or the command should be in the executable path. The user which is used to run MaxScale should have execution rights to the file itself and the directory it resides in. diff --git a/Documentation/Monitors/MySQL-Monitor.md b/Documentation/Monitors/MySQL-Monitor.md index f32af7fde..a3e23c0f0 100644 --- a/Documentation/Monitors/MySQL-Monitor.md +++ b/Documentation/Monitors/MySQL-Monitor.md @@ -25,41 +25,9 @@ MariaDB [(none)]> grant replication client on *.* to 'maxscale'@'maxscalehost'; Query OK, 0 rows affected (0.00 sec) ``` -## Optional parameters for all monitors +## Common Monitor Parameters -Here are optional parameters that are common for all the monitors. - -### `monitor_interval` - -This is the time the monitor waits between each cycle of monitoring. The default value of 10000 milliseconds (10 seconds) should be lowered if you want a faster response to changes in the server states. The value is defined in milliseconds and the smallest possible value is 100 milliseconds. - -``` -monitor_interval=2500 -``` - -### `backend_connect_timeout` - -This parameter controls the timeout for connecting to a monitored server. It is in seconds and the minimum value is 1 second. The default value for this parameter is 3 seconds. - -``` -backend_connect_timeout=6 -``` - -### `backend_write_timeout` - -This parameter controls the timeout for writing to a monitored server. It is in seconds and the minimum value is 1 second. The default value for this parameter is 2 seconds. - -``` -backend_write_timeout=4 -``` - -### `backend_read_timeout` - -This parameter controls the timeout for reading from a monitored server. It is in seconds and the minimum value is 1 second. The default value for this parameter is 1 seconds. - -``` -backend_read_timeout=2 -``` +For a list of optional parameters that all monitors support, read the [Monitor Common](Monitor-Common.md) document. ## MySQL Monitor optional parameters diff --git a/Documentation/Monitors/NDB-Cluster-Monitor.md b/Documentation/Monitors/NDB-Cluster-Monitor.md index 806c7858f..d7cbe6a29 100644 --- a/Documentation/Monitors/NDB-Cluster-Monitor.md +++ b/Documentation/Monitors/NDB-Cluster-Monitor.md @@ -18,42 +18,6 @@ passwd=mypwd ``` -## Optional parameters for all monitors - -Here are optional parameters that are common for all the monitors. - -### `monitor_interval` - -This is the time the monitor waits between each cycle of monitoring. The default value of 10000 milliseconds (10 seconds) should be lowered if you want a faster response to changes in the server states. The value is defined in milliseconds and the smallest possible value is 100 milliseconds. - -``` -monitor_interval=2500 -``` - -### `backend_connect_timeout` - -This parameter controls the timeout for connecting to a monitored server. It is in seconds and the minimum value is 1 second. The default value for this parameter is 3 seconds. - -``` -backend_connect_timeout=6 -``` - -### `backend_write_timeout` - -This parameter controls the timeout for writing to a monitored server. It is in seconds and the minimum value is 1 second. The default value for this parameter is 2 seconds. - -``` -backend_write_timeout=4 -``` - -### `backend_read_timeout` - -This parameter controls the timeout for reading from a monitored server. It is in seconds and the minimum value is 1 second. The default value for this parameter is 1 seconds. - -``` -backend_read_timeout=2 -``` - ### Common Monitor Parameters For a list of optional parameters that all monitors support, read the [Monitor Common](Monitor-Common.md) document.