summaryrefslogtreecommitdiffstats
path: root/health/REFERENCE.md
diff options
context:
space:
mode:
authorIlya Mashchenko <ilya@netdata.cloud>2021-04-14 16:40:46 +0300
committerGitHub <noreply@github.com>2021-04-14 16:40:46 +0300
commit545e2a551fff63f0a7695371f7e2d093af59a18e (patch)
treeda9403fa3263901ad08afd1a47aab62cf4612286 /health/REFERENCE.md
parent4893bdac30ebb8a1d4b5db6bb62554861bc1ebd4 (diff)
health: fix alarm line options syntax in the docs (#10974)
Diffstat (limited to 'health/REFERENCE.md')
-rw-r--r--health/REFERENCE.md8
1 files changed, 4 insertions, 4 deletions
diff --git a/health/REFERENCE.md b/health/REFERENCE.md
index bc5f40ccd5..6621c5bd6c 100644
--- a/health/REFERENCE.md
+++ b/health/REFERENCE.md
@@ -72,7 +72,7 @@ Netdata parses the following lines. Beneath the table is an in-depth explanation
| [`exec`](#alarm-line-exec) | no | The script to execute when the alarm changes status. |
| [`delay`](#alarm-line-delay) | no | Optional hysteresis settings to prevent floods of notifications. |
| [`repeat`](#alarm-line-repeat) | no | The interval for sending notifications when an alarm is in WARNING or CRITICAL mode. |
-| [`option`](#alarm-line-option) | no | Add an option to not clear alarms. |
+| [`options`](#alarm-line-options) | no | Add an option to not clear alarms. |
| [`host labels`](#alarm-line-host-labels) | no | List of labels present on a host. |
The `alarm` or `template` line must be the first line of any entity.
@@ -386,12 +386,12 @@ repeat: [off] [warning DURATION] [critical DURATION]
- `critical DURATION`: Defines the interval when the alarm is in CRITICAL state. Use `0s` to turn off the repeating
notification for CRITICAL mode.
-#### Alarm line `option`
+#### Alarm line `options`
-The only possible value for the `option` line is
+The only possible value for the `options` line is
```yaml
-option: no-clear-notification
+options: no-clear-notification
```
For some alarms we need compare two time-frames, to detect anomalies. For example, `health.d/httpcheck.conf` has an