docs: remove 'families' from health reference (#16380)
Ilya Mashchenko committed
Nov 10, 2023 at 16:52 UTC
6c66219341423187a56d269dcb022f0c0f04e8ad
1 file changed
+2
-22
health/REFERENCE.md
+2
-22
@@ -234,7 +234,6 @@ Netdata parses the following lines. Beneath the table is an in-depth explanation
234
| [`plugin`](#alert-line-plugin) | no | Restrict an alert or template to only a certain plugin. |
235
| [`module`](#alert-line-module) | no | Restrict an alert or template to only a certain module. |
236
| [`charts`](#alert-line-charts) | no | Restrict an alert or template to only certain charts. |
237
-| [`families`](#alert-line-families) | no | Restrict a template to only certain families. |
237
| [`lookup`](#alert-line-lookup) | yes | The database lookup to find and process metrics for the chart specified through `on`. |
238
| [`calc`](#alert-line-calc) | yes (see above) | A calculation to apply to the value found via `lookup` or another variable. |
239
| [`every`](#alert-line-every) | no | The frequency of the alert. |
@@ -438,23 +437,6 @@ template: disk_svctm_alert
437
charts: !*sdb* *
438
```
439
441
-#### Alert line `families`
442
-
443
-The `families` line, used only alongside templates, filters which families within the context this alert should apply
444
-to. The value is a space-separated list.
445
-
446
-The value is a space-separate list of simple patterns. See our [simple patterns docs](https://github.com/netdata/netdata/blob/master/libnetdata/simple_pattern/README.md) for
447
-some examples.
448
-
449
-For example, you can create a template on the `disk.io` context, but filter it to only the `sda` and `sdb` families:
450
-
451
-```yaml
452
-families: sda sdb
453
-```
454
-
455
-Please note that the use of the `families` filter is planned to be deprecated in upcoming Netdata releases.
456
-Please use [`chart labels`](#alert-line-chart-labels) instead.
457
-
440
#### Alert line `lookup`
441
442
This line makes a database lookup to find a value. This result of this lookup is available as `$this`.
@@ -882,13 +864,11 @@ registry](https://registry.my-netdata.io/api/v1/alarm_variables?chart=system.cpu
864
865
Netdata supports 3 internal indexes for variables that will be used in health monitoring.
866
885
-<details markdown="1"><summary>The variables below can be used in both chart alerts and context templates.</summary>
867
+<details><summary>The variables below can be used in both chart alerts and context templates.</summary>
868
869
Although the `alarm_variables` link shows you variables for a particular chart, the same variables can also be used in
870
templates for charts belonging to a given [context](https://github.com/netdata/netdata/blob/master/web/README.md#contexts). The reason is that all charts of a given
889
-context are essentially identical, with the only difference being the [family](https://github.com/netdata/netdata/blob/master/web/README.md#families) that
890
-identifies a particular hardware or software instance. Charts and templates do not apply to specific families anyway,
891
-unless if you explicitly limit an alert with the [alert line `families`](#alert-line-families).
871
+context are essentially identical, with the only difference being the family that identifies a particular hardware or software instance.
872
873
</details>
874