From 513060039eac713270c05efeb7fff43ae85f8def Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Markus=20M=C3=A4kel=C3=A4?= Date: Wed, 13 Sep 2017 23:06:34 +0300 Subject: [PATCH] MXS-1405: Document `script_timeout` Documented the new parameter and added a section to the release notes about the changes in the monitor scripts. --- Documentation/Monitors/Monitor-Common.md | 9 +++++++++ .../Release-Notes/MaxScale-2.2.0-Release-Notes.md | 9 +++++++++ 2 files changed, 18 insertions(+) diff --git a/Documentation/Monitors/Monitor-Common.md b/Documentation/Monitors/Monitor-Common.md index 7f6916b31..ecdb624fb 100644 --- a/Documentation/Monitors/Monitor-Common.md +++ b/Documentation/Monitors/Monitor-Common.md @@ -87,6 +87,15 @@ For example, the previous example will be executed as: /home/user/myscript.sh initiator=[192.168.0.10]:3306 event=master_down live_nodes=[192.168.0.201]:3306,[192.168.0.121]:3306 ``` +### `script_timeout` + +The timeout for the executed script in seconds. The default value is 90 +seconds. + +If the script execution exceeds the configured timeout, it is stopped by sending +a SIGTERM signal to it. If the process does not stop, a SIGKILL signal will be +sent to it once the execution time is greater than twice the configured timeout. + ### `events` A list of event names which cause the script to be executed. If this option is not defined, all events cause the script to be executed. The list must contain a comma separated list of event names. diff --git a/Documentation/Release-Notes/MaxScale-2.2.0-Release-Notes.md b/Documentation/Release-Notes/MaxScale-2.2.0-Release-Notes.md index 386b0a2b9..d8494d79c 100644 --- a/Documentation/Release-Notes/MaxScale-2.2.0-Release-Notes.md +++ b/Documentation/Release-Notes/MaxScale-2.2.0-Release-Notes.md @@ -17,6 +17,15 @@ Significant whitespace in object names is now deprecated. All object names squeezing repeating whitespace and replacing it with hyphens. If any object name conversions take place, a warning will be logged. +### Monitor Scripts + +The execution of monitor scripts has been made synchronous. This means +that a monitor will wait until the executed script is done or until a +timeout is exceeded. The timeout is configurable with the `script_timeout` +parameter. + +For more information, refer to the [monitor documentation](../Monitors/Monitor-Common.md). + ### Read-only Administrative Users Users that can only perform read-only operations can be created with `add