summaryrefslogtreecommitdiffstats
path: root/health
diff options
context:
space:
mode:
authorIlya Mashchenko <ilya@netdata.cloud>2021-05-04 18:31:04 +0300
committerGitHub <noreply@github.com>2021-05-04 18:31:04 +0300
commit924bf118e59ddf72052b75f43c3eb7ef13afe693 (patch)
tree90307abbf7a4be6a533e12ef282092940b25c701 /health
parent7a3a7858c29d91d33b61bad18e738142bd220c28 (diff)
health: clarify which health configuration entities are required / optional (#11086)
Diffstat (limited to 'health')
-rw-r--r--health/REFERENCE.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/health/REFERENCE.md b/health/REFERENCE.md
index efcd9fe013..deee198a69 100644
--- a/health/REFERENCE.md
+++ b/health/REFERENCE.md
@@ -47,9 +47,10 @@ to the same chart, Netdata will use the alarm.
Netdata parses the following lines. Beneath the table is an in-depth explanation of each line's purpose and syntax.
-- The `on` and `lookup` lines are **always required**.
-- Each entity **must** have one of the following lines: `calc`, `warn`, or `crit`.
- The `alarm` or `template` line must be the first line of any entity.
+- The `on` line is **always required**.
+- The `every` line is **required** if not using `lookup`.
+- Each entity **must** have at least one of the following lines: `lookup`, `calc`, `warn`, or `crit`.
- A few lines use space-separated lists to define how the entity behaves. You can use `*` as a wildcard or prefix with
`!` for a negative match. Order is important, too! See our [simple patterns docs](../libnetdata/simple_pattern/) for
more examples.