Skip to content

Commit

Permalink
Docs: clarify output vs notes
Browse files Browse the repository at this point in the history
fixup
  • Loading branch information
Hannah Oppenheimer authored and hannahhearth committed Dec 6, 2018
1 parent 43d882c commit cb32908
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions website/source/docs/agent/checks.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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`
Expand Down

0 comments on commit cb32908

Please sign in to comment.