summaryrefslogtreecommitdiffstats
path: root/health/REFERENCE.md
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--health/REFERENCE.md13
1 files changed, 11 insertions, 2 deletions
diff --git a/health/REFERENCE.md b/health/REFERENCE.md
index 4feb782d6..3c1e53b2a 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.
@@ -311,7 +312,7 @@ Everything is the same with [badges](/web/api/badges/README.md). In short:
above too).
- `OPTIONS` is a space separated list of `percentage`, `absolute`, `min2max`, `unaligned`,
- `match-ids`, `match-names`. Check the badges documentation for more info.
+ `match-ids`, `match-names`. Check the [badges](/web/api/badges/README.md) documentation for more info.
- `of DIMENSIONS` is optional and has to be the last parameter. Dimensions have to be separated
by `,` or `|`. The space characters found in dimensions will be kept as-is (a few dimensions
@@ -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
@@ -913,4 +922,4 @@ to temporary disable notifications (for instance when running backups triggers a
notifications are runtime. The health checks can be controlled at runtime via the [health management
api](/web/api/health/README.md).
-[![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Fhealth%2Freference%2F&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)
+