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

Docs: clarify output vs notes 

fixup
This commit is contained in:
Hannah Oppenheimer 2018-12-05 14:40:48 -06:00 committed by Hannah Oppenheimer
parent 7a20d2b679
commit 18d2269ca2
1 changed files with 3 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -234,9 +234,8 @@ generated. Otherwise, `id` will be set to `name`. If names might conflict,
unique IDs should be provided.
The `notes` field is opaque to Consul but can be used to provide a human-readable
description of the current state of the check. With a script check, the field is
set to any output generated by the script. Similarly, an external process updating
a TTL check via the HTTP interface can set the `notes` value.
description of the current state of the check. Similarly, an external process
updating a TTL check via the HTTP interface can set the `notes` value.
Checks may also contain a `token` field to provide an ACL token. This token is
used for any interaction with the catalog for the check, including
@ -278,8 +277,7 @@ this convention:
* Any other code - Check is failing
This is the only convention that Consul depends on. Any output of the script
will be captured and stored in the `notes` field so that it can be viewed
by human operators.
will be captured and stored in the `output` field.
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`