remove deprecated settings from the health ref doc (#17116)
Ilya Mashchenko committed
Mar 6, 2024 at 11:46 UTC
13466de5ca76f916dff18bb59e5d74c8ca1e1daa
1 file changed
+2
-60
src/health/REFERENCE.md
+2
-60
@@ -60,8 +60,6 @@ For example, here is the first health entity in `health.d/cpu.conf`:
60
class: Utilization
61
type: System
62
component: CPU
63
- os: linux
64
- hosts: *
63
lookup: average -10m unaligned of user,system,softirq,irq,guest
64
units: %
65
every: 1m
@@ -238,10 +236,6 @@ Netdata parses the following lines. Beneath the table is an in-depth explanation
236
| [`class`](#alert-line-class) | no | The general alert classification. |
237
| [`type`](#alert-line-type) | no | What area of the system the alert monitors. |
238
| [`component`](#alert-line-component) | no | Specific component of the type of the alert. |
241
-| [`os`](#alert-line-os) | no | Which operating systems to run this chart. |
242
-| [`hosts`](#alert-line-hosts) | no | Which hostnames will run this alert. |
243
-| [`plugin`](#alert-line-plugin) | no | Restrict an alert or template to only a certain plugin. |
244
-| [`module`](#alert-line-module) | no | Restrict an alert or template to only a certain module. |
239
| [`lookup`](#alert-line-lookup) | yes | The database lookup to find and process metrics for the chart specified through `on`. |
240
| [`calc`](#alert-line-calc) | yes (see above) | A calculation to apply to the value found via `lookup` or another variable. |
241
| [`every`](#alert-line-every) | no | The frequency of the alert. |
@@ -384,54 +378,6 @@ component: MySQL
378
379
As with the `class` and `type` line, if `component` is missing from the configuration, its value will default to `Unknown`.
380
387
-#### Alert line `os`
388
-
389
-The alert or template will be used only if the operating system of the host matches this list specified in `os`. The
390
-value is a space-separated list.
391
-
392
-The following example enables the entity on Linux, FreeBSD, and macOS, but no other operating systems.
393
-
394
-```yaml
395
-os: linux freebsd macos
396
-```
397
-
398
-#### Alert line `hosts`
399
-
400
-The alert or template will be used only if the hostname of the host matches this space-separated list.
401
-
402
-The following example will load on systems with the hostnames `server` and `server2`, and any system with hostnames that
403
-begin with `database`. It _will not load_ on the host `redis3`, but will load on any _other_ systems with hostnames that
404
-begin with `redis`.
405
-
406
-```yaml
407
-hosts: server1 server2 database* !redis3 redis*
408
-```
409
-
410
-#### Alert line `plugin`
411
-
412
-The `plugin` line filters which plugin within the context this alert should apply to. The value is a space-separated
413
-list of [simple patterns](https://github.com/netdata/netdata/blob/master/src/libnetdata/simple_pattern/README.md). For example,
414
-you can create a filter for an alert that applies specifically to `python.d.plugin`:
415
-
416
-```yaml
417
-plugin: python.d.plugin
418
-```
419
-
420
-The `plugin` line is best used with other options like `module`. When used alone, the `plugin` line creates a very
421
-inclusive filter that is unlikely to be of much use in production. See [`module`](#alert-line-module) for a
422
-comprehensive example using both.
423
-
424
-#### Alert line `module`
425
-
426
-The `module` line filters which module within the context this alert should apply to. The value is a space-separated
427
-list of [simple patterns](https://github.com/netdata/netdata/blob/master/src/libnetdata/simple_pattern/README.md). For
428
-example, you can create an alert that applies only on the `isc_dhcpd` module started by `python.d.plugin`:
429
-
430
-```yaml
431
-plugin: python.d.plugin
432
-module: isc_dhcpd
433
-```
434
-
381
#### Alert line `lookup`
382
383
This line makes a database lookup to find a value. This result of this lookup is available as `$this`.
@@ -694,13 +640,13 @@ chart labels: mount_point=!/mnt/disk1 *
640
```
641
642
The `chart labels` is a space-separated list that accepts simple patterns. If you use multiple different chart labels,
697
-then the result is an OR between them. i.e. the following:
643
+then the result is an AND between them. i.e. the following:
644
645
```yaml
646
chart labels: mount_point=/mnt/disk1 device=sda
647
```
648
703
-Will create the alert if the `mount_point` is `/mnt/disk1` or the `device` is `sda`. Furthermore, if a chart label name
649
+Will create the alert if the `mount_point` is `/mnt/disk1` and the `device` is `sda`. Furthermore, if a chart label name
650
is specified that does not exist in the chart, the chart won't be matched.
651
652
See our [simple patterns docs](https://github.com/netdata/netdata/blob/master/src/libnetdata/simple_pattern/README.md) for more examples.
@@ -1096,8 +1042,6 @@ Warning if 5 minute rolling [anomaly rate](https://github.com/netdata/netdata/bl
1042
```yaml
1043
template: ml_5min_cpu_chart
1044
on: system.cpu
1099
- os: linux
1100
- hosts: *
1045
lookup: average -5m anomaly-bit of *
1046
calc: $this
1047
units: %
@@ -1117,8 +1061,6 @@ Warning if 5 minute rolling [anomaly rate](https://github.com/netdata/netdata/bl
1061
```yaml
1062
template: ml_5min_node
1063
on: anomaly_detection.anomaly_rate
1120
- os: linux
1121
- hosts: *
1064
lookup: average -5m of anomaly_rate
1065
calc: $this
1066
units: %