From 4ab59af09e85578c6816bf03ed0a815f660ed570 Mon Sep 17 00:00:00 2001 From: Kyle Havlovitz Date: Wed, 11 Oct 2017 14:55:55 -0700 Subject: [PATCH] Clarify the docs around script check timeout behavior --- website/source/docs/agent/checks.html.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/website/source/docs/agent/checks.html.md b/website/source/docs/agent/checks.html.md index 6b1595d0db..98fad1845f 100644 --- a/website/source/docs/agent/checks.html.md +++ b/website/source/docs/agent/checks.html.md @@ -22,13 +22,16 @@ There are five different kinds of checks: generates some output. A script is paired with an invocation interval (e.g. every 30 seconds). This is similar to the Nagios plugin system. The output of a script check is limited to 4KB. Output larger than this will be truncated. + By default, Script checks will be configured with a timeout equal to 30 seconds. It is possible to configure a custom Script check timeout value by specifying the - `timeout` field in the check definition. On Windows, Consul will wait for any child processes - spawned by the script to finish once the timeout is reached (instead of killing them immediately, - as on other platforms). In Consul 0.9.0 and later, the agent must be configured with - [`enable_script_checks`](/docs/agent/options.html#_enable_script_checks) set to `true` - in order to enable script checks. + `timeout` field in the check definition. When the timeout is reached on Windows, + Consul will wait for any child processes spawned by the script to finish. For any + other system, Consul will attempt to force-kill the script and any child processes + it has spawned once the timeout has passed. + + In Consul 0.9.0 and later, the agent must be configured with [`enable_script_checks`] + (/docs/agent/options.html#_enable_script_checks) set to `true` in order to enable script checks. * HTTP + Interval - These checks make an HTTP `GET` request every Interval (e.g. every 30 seconds) to the specified URL. The status of the service depends on