diff options
| author | thiagoftsm <thiagoftsm@gmail.com> | 2020-10-20 09:00:14 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-20 12:00:14 +0300 |
| commit | 6b2ffc355a0d450e4569f3d5412b18d709318986 (patch) | |
| tree | b474903e876b5701d80bcd4eb15797762961c29f /health/REFERENCE.md | |
| parent | 7c33c4c70f4588313ed697885065092ad9a2b29a (diff) | |
New alarm entities (#10041)
Co-authored-by: Joel Hans <joel.g.hans@gmail.com>
Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
Diffstat (limited to 'health/REFERENCE.md')
| -rw-r--r-- | health/REFERENCE.md | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/health/REFERENCE.md b/health/REFERENCE.md index 962d04e087..b7301b3a2b 100644 --- a/health/REFERENCE.md +++ b/health/REFERENCE.md @@ -60,6 +60,8 @@ Netdata parses the following lines. Beneath the table is an in-depth explanation | [`on`](#alarm-line-on) | yes | The chart this alarm should attach to. | | [`os`](#alarm-line-os) | no | Which operating systems to run this chart. | | [`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. | | [`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. | @@ -150,6 +152,31 @@ begin with `redis`. hosts: server1 server2 database* !redis3 redis* ``` +#### Alarm line `plugin` + +The `plugin` line filters which plugin within the context this alarm should apply to. The value is a space-separated +list of [simple patterns](/libnetdata/simple_pattern/README.md). For example, +you can create a filter for an alarm that applies specifically to `python.d.plugin`: + +```yaml +plugin: python.d.plugin +``` + +The `plugin` line is best used with other options like `module`. When used alone, the `plugin` line creates a very +inclusive filter that is unlikely to be of much use in production. See [`module`](#alarm-line-module) for a +comprehensive example using both. + +#### Alarm line `module` + +The `module` line filters which module within the context this alarm should apply to. The value is a space-separated +list of [simple patterns](/libnetdata/simple_pattern/README.md). For +example, you can create an alarm that applies only on the `isc_dhcpd` module started by `python.d.plugin`: + +```yaml +plugin: python.d.plugin +module: isc_dhcpd +``` + #### Alarm line `families` The `families` line, used only alongside templates, filters which families within the context this alarm should apply |