diff options
| author | Emmanuel Vasilakis <mrzammler@mm.st> | 2021-05-17 21:10:53 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-17 21:10:53 +0300 |
| commit | de4a000acd55bf29dd3cbb966d9bf1e459d6c668 (patch) | |
| tree | 268db9d89c9dd5ff9fe8299f4768454de17b763a | |
| parent | e75a06ce37e84a3a50a4ea1c4db6f391b9a708fa (diff) | |
Add sections for class, component and type. (#10984)
* Add sections for class, component and type.
Add sections in the documentation for the new `class`, `component` and `type` attributes, that the PR https://github.com/netdata/netdata/pull/10961 adds to the stock alarms configuration files.
The documentation can be perhaps extended to provide information on how those attributes are used in the cloud.
* Update REFERENCE.md
Add a list of stock alarms class attributes.
* Add notes for default value Unknown
* Update REFERENCE.md
Fill more class descriptions (and change the name of the column).
* Update REFERENCE.md
Add collapsible class table.
* Update health/REFERENCE.md
Use dot
Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
* Update health/REFERENCE.md
Spelling
Co-authored-by: Joel Hans <joel@netdata.cloud>
* Update health/REFERENCE.md
Spelling
Co-authored-by: Joel Hans <joel@netdata.cloud>
* Update health/REFERENCE.md
Grammar
Co-authored-by: Joel Hans <joel@netdata.cloud>
Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
Co-authored-by: Joel Hans <joel@netdata.cloud>
| -rw-r--r-- | health/REFERENCE.md | 64 |
1 files changed, 64 insertions, 0 deletions
diff --git a/health/REFERENCE.md b/health/REFERENCE.md index deee198a69..5ea6b7c5d6 100644 --- a/health/REFERENCE.md +++ b/health/REFERENCE.md @@ -59,6 +59,9 @@ Netdata parses the following lines. Beneath the table is an in-depth explanation | --------------------------------------------------- | --------------- | ------------------------------------------------------------------------------------- | | [`alarm`/`template`](#alarm-line-alarm-or-template) | yes | Name of the alarm/template. | | [`on`](#alarm-line-on) | yes | The chart this alarm should attach to. | +| [`class`](#alarm-line-class) | no | The general classification of the alarm. | +| [`component`](#alarm-line-component) | no | Specify the component of the class of the alarm. | +| [`type`](#alarm-line-type) | no | The type of error the alarm monitors. | | [`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. | @@ -131,6 +134,67 @@ You're interested in what comes after the comma: `disk.io`. That's the name of t If you create a template using the `disk.io` context, it will apply an alarm to every disk available on your system. +#### Alarm line `class` + +Specify the classification of the alarm or template. + +Class can be used to indicate the broader area of the system that the alarm applies to. For example, under the general `Database` class, you can group together alarms that operate on various database systems, like `MySQL`, `CockroachDB`, `CouchDB` etc. Example: + +```yaml +class: Database +``` +<details> +<summary>Netdata's stock alarms use the following `class` attributes by default, but feel free to adjust for your own requirements.</summary> + +| Class | Description | +| ------------------------ | ------------------------------------------------------------------------------------------------ | +| Ad Filtering | Services related to Ad Filtering (like pi-hole) | +| Certificates | Certificates monitoring related | +| Cgroups | Alerts for cpu and memory usage of control groups | +| Computing | Alerts for shared computing applications (e.g. boinc) | +| Containers | Container related alerts (e.g. docker instances) | +| Database | Database systems (e.g. MySQL, Postgress, etc) | +| Data Sharing | Used to group together alerts for data sharing applications | +| DHCP | Alerts for dhcp related services | +| DNS | Alerts for dns related services | +| Kubernetes | Alerts for kubernetes nodes monitoring | +| KV Storage | Key-Value pairs services alerts (e.g. memcached) | +| Linux | Services specific to Linux (e.g. systemd) | +| Messaging | Alerts for message passing services (e.g. vernemq) | +| Netdata | Internal Netdata components monitoring | +| Other | Use as a general class of alerts | +| Power Supply | Alerts from power supply related services (e.g. apcupsd) | +| Search engine | Alerts for search services (e.g. elasticsearch) | +| Storage | Class for alerts dealing with storage services (storage devices typically live under `System`) | +| System | General system alarms (e.g. cpu, network, etc.) | +| Virtual Machine | Virtual Machine software | +| Web Proxy | Web proxy software (e.g. squid) | +| Web Server | Web server software (e.g. Apache, ngnix, etc.) | +| Windows | Alerts for monitor of wmi services | + +</details> + +If an alarm configuration is missing the `class` line, its value will default to `Unknown`. + +#### Alarm line `component` + +Component can be used to narrow down what the previous `class` value specifies for each alarm or template. Continuing from the previous example, `component` might include `MySQL`, `CockroachDB`, `MongoDB`, all under the same `Database` classification. Example: + +```yaml +component: MySQL +``` +As with the `class` line, if `component` is missing from the configuration, its value will default to `Unknown`. + +#### Alarm line `type` + +This indicates the type of error (or general problem area) that the alarm or template applies to. For example, `Latency` can be used for alarms that trigger on latency issues in network interfaces, web servers, or database systems. Example: + +```yaml +type: Latency +``` + +`type` will also (as with `class` and `component`) default to `Unknown` if the line is missing from the alarm configuration. + #### Alarm line `os` The alarm or template will be used only if the operating system of the host matches this list specified in `os`. The |