Necessary changes for Learn (#16651)
Co-authored-by: Ilya Mashchenko <ilya@netdata.cloud>
Fotis Voutsas committed
Dec 21, 2023 at 15:55 UTC
f2dfd8de585e2a3206d6f67dad5932ccacfc02ea
1 file changed
+33
-33
docs/cloud/alerts-configuration-manager.md
+33
-33
@@ -12,7 +12,7 @@ The Netdata Alerts Configuration Manager enables users with [Business subscripti
12
- Alert Configuration Manager will open up with the `default` thresholds. Modify the configuration as required and the alert definition on the right will be updated dynamically.
13
14
15
-- If you want more fine grained control or access to more advanced settings, enable `Show advanced`
15
+- If you want more fine-grained control or access to more advanced settings, enable `Show advanced`
16
17
18
- Copy the alert definition that is generated in the code box and add it to an existing [health configuration file](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#edit-health-configuration-files) or a new custom file under `<path to netdata install>/etc/netdata/health.d/` on a `Parent Agent` or a `Standalone Child Agent`.
@@ -23,49 +23,49 @@ The Netdata Alerts Configuration Manager enables users with [Business subscripti
23
24
## Alerts Configuration Manager Sections
25
26
-1. **Alert Name, Description and Summary Section**
26
+- **Alert Name, Description and Summary Section**
27
28
29
- - **Alert Template Name**: This field uniquely identifies an alert and corresponds to the [template](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-alarm-or-template) field of the Alert configuration. The Alerts Configuration Manager provides a default name for an Alert template but we recommend you to modify this to have a meaningful name for your configured alert.
30
- - **Alert Template Description**: This field provides a description to the alert and corresponds to the [info](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-info) line of the Alert configuration.
31
- - **Alert Summary**: This field enables the users to customise a title for the Alert Notifications (via [Notification integrations](https://learn.netdata.cloud/docs/alerting/notifications/centralized-cloud-notifications)) and corresponds to the [summary](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-summary) line of the Alert configuration.
29
+ - **Alert Template Name**: This field uniquely identifies an alert and corresponds to the [template](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-alarm-or-template) field of the Alert configuration. The Alerts Configuration Manager provides a default name for an Alert template but we recommend you to modify this to have a meaningful name for your configured alert.
30
+ - **Alert Template Description**: This field describes the alert and corresponds to the [info](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-info) line of the Alert configuration.
31
+ - **Alert Summary**: This field enables the users to customize a title for the Alert Notifications (via [Notification integrations](https://learn.netdata.cloud/docs/alerting/notifications/centralized-cloud-notifications)) and corresponds to the [summary](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-summary) line of the Alert configuration.
32
33
-2. **Alert Type**
33
+- **Alert Type**
34
35
- The users can select the type of Alert that they want to create:
36
- - Standard `threshold` based alerts.
37
- - `Variance` based alerts
38
- - `Anomalies` based alerts
35
+ The users can select the type of Alert that they want to create:
36
+ - Standard `threshold` based alerts.
37
+ - `Variance` based alerts
38
+ - `Anomalies` based alerts
39
40
41
-3. **Metrics Lookup, Filtering and Formula Section**
41
+- **Metrics Lookup, Filtering and Formula Section**
42
43
44
- - **Metrics Lookup**: This field defines the parameters of a database lookup that is needed to compute the value that will be compared against the alert definition and corresponds to the `[lookup](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-lookup)` line of the Alert configuration. The Alerts Configuration Manager provides a default selection for the lookup and can be modified to suit your requirements. The parameters that you are allowed to modify are:
45
- - METHOD `(avg, sum, min, max, cv, stddev)`
46
- - COMPUTATION `(sum of all dimensions or individually for each dimension)`
47
- - DIMENSIONS `(All dimensions, or a selection of dimensions)`
48
- - DURATION `(the period in time to run the lookup)` and
49
- - OPTIONS `(absolute, unaligned, percentage, min2max)`. This field is available in the `Basic Options`.
44
+ - **Metrics Lookup**: This field defines the parameters of a database lookup that is needed to compute the value that will be compared against the alert definition and corresponds to the `[lookup](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-lookup)` line of the Alert configuration. The Alerts Configuration Manager provides a default selection for the lookup and can be modified to suit your requirements. The parameters that you are allowed to modify are:
45
+ - METHOD `(avg, sum, min, max, cv, stddev)`
46
+ - COMPUTATION `(sum of all dimensions or individually for each dimension)`
47
+ - DIMENSIONS `(All dimensions, or a selection of dimensions)`
48
+ - DURATION `(the period in time to run the lookup)` and
49
+ - OPTIONS `(absolute, unaligned, percentage, min2max)`. This field is available in the `Basic Options`.
50
51
- - **Alert Filtering**: This field enables the users to filter the alert health checks to be run only for specific components of the infrastructure and helps in fine grained configuration of the alerts. This is only available in the `Advance Options`.
52
- - `HOSTS / NODES` - By default all hosts are selected. You can choose / enter a wildcard matching a list of hosts you want this alert health check to run on. This field corresponds to the [hosts](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-hosts) line of the Alert configuration.
53
- - `INSTANCES` - By default all instances are selected. You can choose / enter a wildcard matching a list of instances you want this alert health check to run on. This field corresponds to the [charts](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-charts) line of the Alert configuration.
54
- - `CHART LABELS` - By default all chart labels are selected. You can choose a chart label and select or enter a wildcard matching a list of chart label values you want this alert health check to run on. This field corresponds to the [chart labels](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-chart-labels) line of the Alert configuration.
55
- - `OS` - By default all Operating Systems are selected. You can choose which OSes are relevant for this alert health check to run on. This field corresponds to the [os](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-os) line of the Alert configuration.
51
+ - **Alert Filtering**: This field enables the users to filter the alert health checks to be run only for specific components of the infrastructure and helps in fine-grained configuration of the alerts. This is only available in the `Advance Options`.
52
+ - `HOSTS / NODES` - By default all hosts are selected. You can choose / enter a wildcard matching a list of hosts you want this alert health check to run on. This field corresponds to the [hosts](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-hosts) line of the Alert configuration.
53
+ - `INSTANCES` - By default all instances are selected. You can choose / enter a wildcard matching a list of instances you want this alert health check to run on. This field corresponds to the [charts](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-charts) line of the Alert configuration.
54
+ - `CHART LABELS` - By default all chart labels are selected. You can choose a chart label and select or enter a wildcard matching a list of chart label values you want this alert health check to run on. This field corresponds to the [chart labels](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-chart-labels) line of the Alert configuration.
55
+ - `OS` - By default all Operating Systems are selected. You can choose which OSes are relevant for this alert health check to run on. This field corresponds to the [os](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-os) line of the Alert configuration.
56
57
- - **Formula / Calculation**: This field enables the user to define a formula that will be run on top of the `Lookup` above. The result of the lookup is available in `$this` and after defining the formula, the result of the `formula` is also stored in `$this` and can be accessed while setting the alert thresholds. This field corresponds to the [calc](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-calc) line of the Alert configuration. This is only available in the `Advance Options`.
57
+ - **Formula / Calculation**: This field enables the user to define a formula that will be run on top of the `Lookup` above. The result of the lookup is available in `$this` and after defining the formula, the result of the `formula` is also stored in `$this` and can be accessed while setting the alert thresholds. This field corresponds to the [calc](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-calc) line of the Alert configuration. This is only available in the `Advance Options`.
58
59
-4. **Alert Thresholds**
59
+- **Alert Thresholds**
60
61
- - **Warning and Critical Threshold**: This field enables the users to set a threshold to raise alerts as `Warning` or `Critical` and corresponds to the [warn](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-lines-warn-and-crit) line of the Alert configuration.
62
- - **Recovery Thresholds**: This field enables the users to set a different threshold to de-escalate the severity of an alert from `Critical to Warning` or `Warning to Clear`.
63
- - **Delay Notifications**: This field enables the users to set a delay on notifications for an alert severity `escalation` or `de-escalation` and corresponds to the [delay](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-delay) line of the Alert configuration.
64
- - **Check Interval**: This fiels enables the users to define the frequency of the health check for the alert being defined and corresponds to the [every](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-every) line of the Alert configuration.
61
+ - **Warning and Critical Threshold**: This field enables the users to set a threshold to raise alerts as `Warning` or `Critical` and corresponds to the [warn](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-lines-warn-and-crit) line of the Alert configuration.
62
+ - **Recovery Thresholds**: This field enables the users to set a different threshold to de-escalate the severity of an alert from `Critical to Warning` or `Warning to Clear`.
63
+ - **Delay Notifications**: This field enables the users to set a delay on notifications for an alert severity `escalation` or `de-escalation` and corresponds to the [delay](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-delay) line of the Alert configuration.
64
+ - **Check Interval**: This field enables the users to define the frequency of the health check for the alert being defined and corresponds to the [every](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-every) line of the Alert configuration.
65
66
-5. **Agent Specific Options**
67
- These options are only available on the `Netdata Agent` and not honoured on `Netdata Cloud`.
66
+- **Agent Specific Options**
67
+ These options are only available on the `Netdata Agent` and not honored on `Netdata Cloud`.
68
69
- - **Repeat Notifications**: This field allows the users to define if you want to repeat sending the `alert notifications` when the alert is active and corresponds to the [repeat](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-repeat) line of the Alert configuration.
70
- - **Send to**: This field enables the users to define a `user role` to which the alert notifications need to be sent or `silence` the notifications and corresponds to the [to](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-to) line of the Alert configuration.
71
- - **Custom Exec Script**: This field enables the users to define a custom script to be executed when the alert is triggered (but needs to be carefully designed as it neads to call the `health_alarm_notify.sh` module) and corresponds to the [exec](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-exec) line of the Alert Configuration.
69
+ - **Repeat Notifications**: This field allows the users to define if they want to repeat sending the `alert notifications` when the alert is active and corresponds to the [repeat](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-repeat) line of the Alert configuration.
70
+ - **Send to**: This field enables the users to define a `user role` to which the alert notifications need to be sent or `silence` the notifications and corresponds to the [to](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-to) line of the Alert configuration.
71
+ - **Custom Exec Script**: This field enables the users to define a custom script to be executed when the alert is triggered (but needs to be carefully designed as it needs to call the `health_alarm_notify.sh` module) and corresponds to the [exec](https://learn.netdata.cloud/docs/alerting/health-configuration-reference#alert-line-exec) line of the Alert Configuration.