luxolus
/
open-consul
2
0
Fork 0
Code Issues 1 Pull Requests Packages Releases Wiki Activity

Clarify the docs around script check timeout behavior

This commit is contained in:
Kyle Havlovitz 2017-10-11 14:55:55 -07:00
parent 7ec211dcfd
commit d2b9ab2b4f
No known key found for this signature in database
GPG Key ID: 8A5E6B173056AD6C
1 changed files with 8 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
website/source/docs/agent/checks.html.md
View File

@ -22,13 +22,16 @@ There are five different kinds of checks:
generates some output. A script is paired with an invocation interval (e.g. 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 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. 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. 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 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 `timeout` field in the check definition. When the timeout is reached on Windows,
spawned by the script to finish once the timeout is reached (instead of killing them immediately, Consul will wait for any child processes spawned by the script to finish. For any
as on other platforms). In Consul 0.9.0 and later, the agent must be configured with other system, Consul will attempt to force-kill the script and any child processes
[`enable_script_checks`](/docs/agent/options.html#_enable_script_checks) set to `true` it has spawned once the timeout has passed.
in order to enable script checks.
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. * 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 every 30 seconds) to the specified URL. The status of the service depends on