summaryrefslogtreecommitdiffstats
path: root/health/REFERENCE.md
diff options
context:
space:
mode:
authorthiagoftsm <thiagoftsm@gmail.com>2021-04-28 23:32:43 +0000
committerGitHub <noreply@github.com>2021-04-28 23:32:43 +0000
commite1b409efd10491b281e39f5637a08fb7b542866d (patch)
treebf3484d717d1410fd526250a2c7847277839b456 /health/REFERENCE.md
parent6ec39d20ccb48f90b8e801dd91f51ab9141b941a (diff)
Add `charts` to templates (#11054)
Add new entities to Netdata templates.
Diffstat (limited to 'health/REFERENCE.md')
-rw-r--r--health/REFERENCE.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/health/REFERENCE.md b/health/REFERENCE.md
index 6621c5bd6c..efcd9fe013 100644
--- a/health/REFERENCE.md
+++ b/health/REFERENCE.md
@@ -62,6 +62,7 @@ Netdata parses the following lines. Beneath the table is an in-depth explanation
| [`hosts`](#alarm-line-hosts) | no | Which hostnames will run this alarm. |
| [`plugin`](#alarm-line-plugin) | no | Restrict an alarm or template to only a certain plugin. |
| [`module`](#alarm-line-module) | no | Restrict an alarm or template to only a certain module. |
+| [`charts`](#alarm-line-charts) | no | Restrict an alarm or template to only certain charts. |
| [`families`](#alarm-line-families) | no | Restrict a template to only certain families. |
| [`lookup`](#alarm-line-lookup) | yes | The database lookup to find and process metrics for the chart specified through `on`. |
| [`calc`](#alarm-line-calc) | yes (see above) | A calculation to apply to the value found via `lookup` or another variable. |
@@ -177,6 +178,19 @@ plugin: python.d.plugin
module: isc_dhcpd
```
+#### Alarm line `charts`
+
+The `charts` line filters which chart this alarm should apply to. It is only available on entities using the
+[`template`](#alarm-line-alarm-or-template) line.
+The value is a space-separated list of [simple patterns](/libnetdata/simple_pattern/README.md). For
+example, a template that applies to `disk.svctm` (Average Service Time) context, but excludes the disk `sdb` from alarms:
+
+```yaml
+template: disk_svctm_alarm
+ on: disk.svctm
+ charts: !*sdb* *
+```
+
#### Alarm line `families`
The `families` line, used only alongside templates, filters which families within the context this alarm should apply