diff options
| author | Emmanuel Vasilakis <mrzammler@mm.st> | 2022-02-22 14:01:26 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-02-22 14:01:26 +0200 |
| commit | d70cedbf90ab99b9c3dd870d1f9c1a8a184d251f (patch) | |
| tree | f12fa8be9c8e38e34746afe8b9f4d4f2bc8a83ee /health/REFERENCE.md | |
| parent | 1c23dbfe480a4412a5df2fb7ca2c001b0a24c98c (diff) | |
Skip info field in protobuf alerts messages if it doesn't exist. (#12210)
* dont assume info field exists
* add info field to documentation
Diffstat (limited to 'health/REFERENCE.md')
| -rw-r--r-- | health/REFERENCE.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/health/REFERENCE.md b/health/REFERENCE.md index 42aa2ef3f7..f650c3400f 100644 --- a/health/REFERENCE.md +++ b/health/REFERENCE.md @@ -82,6 +82,7 @@ Netdata parses the following lines. Beneath the table is an in-depth explanation | [`repeat`](#alarm-line-repeat) | no | The interval for sending notifications when an alarm is in WARNING or CRITICAL mode. | | [`options`](#alarm-line-options) | no | Add an option to not clear alarms. | | [`host labels`](#alarm-line-host-labels) | no | List of labels present on a host. | +| [`info`](#alarm-line-info) | no | A brief description of the alarm. | The `alarm` or `template` line must be the first line of any entity. @@ -533,6 +534,14 @@ host labels: installed = 201* See our [simple patterns docs](/libnetdata/simple_pattern/README.md) for more examples. +#### Alarm line `info` + +The info field can contain a small piece of text describing the alarm or template. This will be rendered in notifications and UI elements whenever the specific alarm is in focus. An example for the `ram_available` alarm is: + +```yaml +info: percentage of estimated amount of RAM available for userspace processes, without causing swapping +``` + ## Expressions Netdata has an internal [infix expression parser](/libnetdata/eval). This parses expressions and creates an internal |