Skip to content

Commit c60f522

Browse files
authored
Merge pull request #2394 from netdata/docusaurus-v3
Upgrade Docusaurus to v3.7.0
2 parents 1f99fd5 + 0b8c7e1 commit c60f522

File tree

595 files changed

+4579
-2944
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

595 files changed

+4579
-2944
lines changed

docs/alerts-&-notifications/alert-configuration-reference.mdx

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -402,7 +402,7 @@ The full [database query API](/docs/developer-and-contributor-corner/rest-api/qu
402402
- `METHOD` is one of the available [grouping methods](/docs/developer-and-contributor-corner/rest-api/queries#grouping-methods) such as `average`, `min`, `max` etc.
403403
This is required.
404404

405-
- `GROUPING OPTIONS` are optional and can have the form `CONDITION VALUE`, where `CONDITION` is `!=`, `=`, `<=`, `<`, `>`, `>=` and `VALUE` is a number. The `CONDITION` and `VALUE` are required for `countif`, while `VALUE` is used by `percentile`, `trimmed_mean` and `trimmed_median`.
405+
- `GROUPING OPTIONS` are optional and can have the form `CONDITION VALUE`, where `CONDITION` is `!=`, `=`, `\<=`, `<`, `>`, `>=` and `VALUE` is a number. The `CONDITION` and `VALUE` are required for `countif`, while `VALUE` is used by `percentile`, `trimmed_mean` and `trimmed_median`.
406406

407407
- `AFTER` is a relative number of seconds, but it also accepts a single letter for changing
408408
the units, like `-1s` = 1 second in the past, `-1m` = 1 minute in the past, `-1h` = 1 hour
@@ -649,7 +649,7 @@ See our [simple patterns docs](/docs/developer-and-contributor-corner/libnetdata
649649
Similar to host labels, the `chart labels` key can be used to filter if an alert loads or not for a specific chart, based on
650650
whether these chart labels match or not.
651651

652-
The list of chart labels present on each chart can be obtained from <http://localhost:19999/api/v1/charts?all>
652+
The list of chart labels present on each chart can be obtained from [http://localhost:19999/api/v1/charts?all](http://localhost:19999/api/v1/charts?all)
653653

654654
For example, each `disk_space` chart defines a chart label called `mount_point` with each instance of this chart having
655655
a value there of which mount point it monitors.
@@ -687,13 +687,13 @@ alert information. Current variables supported are:
687687

688688
| variable | description |
689689
|---------------------|-------------------------------------------------------------------|
690-
| ${family} | Will be replaced by the family instance for the alert (e.g. eth0) |
691-
| ${label:LABEL_NAME} | The variable will be replaced with the value of the chart label |
690+
| $\{family} | Will be replaced by the family instance for the alert (e.g. eth0) |
691+
| $\{label:LABEL_NAME} | The variable will be replaced with the value of the chart label |
692692

693693
For example, a summary field like the following:
694694

695695
```yaml
696-
summary: 1 minute received traffic overflow for ${label:device}
696+
summary: 1 minute received traffic overflow for $\{label:device}
697697
```
698698

699699
Will be rendered on the alert acting on interface `eth0` as:
@@ -718,13 +718,13 @@ alert information. Current variables supported are:
718718

719719
| variable | description |
720720
|---------------------|-------------------------------------------------------------------|
721-
| ${family} | Will be replaced by the family instance for the alert (e.g. eth0) |
722-
| ${label:LABEL_NAME} | The variable will be replaced with the value of the chart label |
721+
| $\{family} | Will be replaced by the family instance for the alert (e.g. eth0) |
722+
| $\{label:LABEL_NAME} | The variable will be replaced with the value of the chart label |
723723

724724
For example, an info field like the following:
725725

726726
```yaml
727-
info: average inbound utilization for the network interface ${family} over the last minute
727+
info: average inbound utilization for the network interface $\{family} over the last minute
728728
```
729729

730730
Will be rendered on the alert acting on interface `eth0` as:
@@ -737,7 +737,7 @@ An alert acting on a chart that has a chart label named e.g. `target`, with a va
737737
can be enriched as follows:
738738

739739
```yaml
740-
info: average ratio of HTTP responses with unexpected status over the last 5 minutes for the site ${label:target}
740+
info: average ratio of HTTP responses with unexpected status over the last 5 minutes for the site $\{label:target}
741741
```
742742

743743
Will become:
@@ -753,7 +753,7 @@ info: average ratio of HTTP responses with unexpected status over the last 5 min
753753
Netdata has an internal infix expression parser under `libnetdata/eval`. This parses expressions and creates an internal
754754
structure that allows fast execution of them.
755755

756-
These operators are supported `+`, `-`, `*`, `/`, `<`, `==`, `<=`, `<>`, `!=`, `>`, `>=`, `&&`, `||`, `!`, `AND`, `OR`, `NOT`.
756+
These operators are supported `+`, `-`, `*`, `/`, `<`, `==`, `\<=`, `<>`, `!=`, `>`, `>=`, `&&`, `||`, `!`, `AND`, `OR`, `NOT`.
757757
Boolean operators result in either `1` (true) or `0` (false).
758758

759759
The conditional evaluation operator `?` is supported too. Using this operator, IF-THEN-ELSE conditional statements can be
@@ -809,7 +809,8 @@ registry](https://registry.my-netdata.io/api/v1/alarm_variables?chart=system.cpu
809809

810810
Netdata supports three internal indexes for variables that will be used in health monitoring.
811811

812-
<details><summary>The variables below can be used in both chart alerts and context templates.</summary>
812+
<details>
813+
<summary>The variables below can be used in both chart alerts and context templates.</summary>
813814

814815
Although the `alarm_variables` link shows you variables for a particular chart, the same variables can also be used in
815816
templates for charts belonging to a given context. The reason is that all charts of a given

docs/alerts-&-notifications/notifications/agent-dispatched-notifications/agent-notifications-reference.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,15 +94,15 @@ You can edit `health_alarm_notify.conf` using the `edit-config` script to config
9494
- **Recipients** per role per notification method
9595

9696
```text
97-
role_recipients_email[sysadmin]="${DEFAULT_RECIPIENT_EMAIL}"
98-
role_recipients_pushover[sysadmin]="${DEFAULT_RECIPIENT_PUSHOVER}"
99-
role_recipients_pushbullet[sysadmin]="${DEFAULT_RECIPIENT_PUSHBULLET}"
100-
role_recipients_telegram[sysadmin]="${DEFAULT_RECIPIENT_TELEGRAM}"
101-
role_recipients_slack[sysadmin]="${DEFAULT_RECIPIENT_SLACK}"
97+
role_recipients_email[sysadmin]="$\{DEFAULT_RECIPIENT_EMAIL}"
98+
role_recipients_pushover[sysadmin]="$\{DEFAULT_RECIPIENT_PUSHOVER}"
99+
role_recipients_pushbullet[sysadmin]="$\{DEFAULT_RECIPIENT_PUSHBULLET}"
100+
role_recipients_telegram[sysadmin]="$\{DEFAULT_RECIPIENT_TELEGRAM}"
101+
role_recipients_slack[sysadmin]="$\{DEFAULT_RECIPIENT_SLACK}"
102102
...
103103
```
104104

105-
Here you can change the `${DEFAULT_...}` values to the values of the recipients you want, separated by a space if you have multiple recipients.
105+
Here you can change the `$\{DEFAULT_...}` values to the values of the recipients you want, separated by a space if you have multiple recipients.
106106

107107
## Testing Alert Notifications
108108

docs/alerts-&-notifications/notifications/agent-dispatched-notifications/alerta.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,8 @@ sudo ./edit-config health_alarm_notify.conf
5252

5353
The following options can be defined for this notification
5454

55-
<details open><summary>Config Options</summary>
55+
<details open>
56+
<summary>Config Options</summary>
5657

5758
| Name | Description | Default | Required |
5859
|:----|:-----------|:-------|:--------:|

docs/alerts-&-notifications/notifications/agent-dispatched-notifications/aws-sns.mdx

Lines changed: 38 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -69,13 +69,14 @@ sudo ./edit-config health_alarm_notify.conf
6969

7070
The following options can be defined for this notification
7171

72-
<details open><summary>Config Options</summary>
72+
<details open>
73+
<summary>Config Options</summary>
7374

7475
| Name | Description | Default | Required |
7576
|:----|:-----------|:-------|:--------:|
7677
| aws path | The full path of the aws command. If empty, the system `$PATH` will be searched for it. If not found, Amazon SNS notifications will be silently disabled. | | yes |
7778
| SEND_AWSNS | Set `SEND_AWSNS` to YES | YES | yes |
78-
| AWSSNS_MESSAGE_FORMAT | Set `AWSSNS_MESSAGE_FORMAT` to to the string that you want the alert to be sent into. | ${status} on ${host} at ${date}: ${chart} ${value_string} | yes |
79+
| AWSSNS_MESSAGE_FORMAT | Set `AWSSNS_MESSAGE_FORMAT` to to the string that you want the alert to be sent into. | $\{status} on $\{host} at $\{date}: $\{chart} $\{value_string} | yes |
7980
| DEFAULT_RECIPIENT_AWSSNS | Set `DEFAULT_RECIPIENT_AWSSNS` to the Topic ARN you noted down upon creating the Topic. | | yes |
8081

8182
##### AWSSNS_MESSAGE_FORMAT
@@ -84,40 +85,40 @@ The supported variables are:
8485

8586
| Variable name | Description |
8687
|:---------------------------:|:---------------------------------------------------------------------------------|
87-
| `${alarm}` | Like "name = value units" |
88-
| `${status_message}` | Like "needs attention", "recovered", "is critical" |
89-
| `${severity}` | Like "Escalated to CRITICAL", "Recovered from WARNING" |
90-
| `${raised_for}` | Like "(alarm was raised for 10 minutes)" |
91-
| `${host}` | The host generated this event |
92-
| `${url_host}` | Same as ${host} but URL encoded |
93-
| `${unique_id}` | The unique id of this event |
94-
| `${alarm_id}` | The unique id of the alarm that generated this event |
95-
| `${event_id}` | The incremental id of the event, for this alarm id |
96-
| `${when}` | The timestamp this event occurred |
97-
| `${name}` | The name of the alarm, as given in netdata health.d entries |
98-
| `${url_name}` | Same as ${name} but URL encoded |
99-
| `${chart}` | The name of the chart (type.id) |
100-
| `${url_chart}` | Same as ${chart} but URL encoded |
101-
| `${status}` | The current status : REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL |
102-
| `${old_status}` | The previous status: REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL |
103-
| `${value}` | The current value of the alarm |
104-
| `${old_value}` | The previous value of the alarm |
105-
| `${src}` | The line number and file the alarm has been configured |
106-
| `${duration}` | The duration in seconds of the previous alarm state |
107-
| `${duration_txt}` | Same as ${duration} for humans |
108-
| `${non_clear_duration}` | The total duration in seconds this is/was non-clear |
109-
| `${non_clear_duration_txt}` | Same as ${non_clear_duration} for humans |
110-
| `${units}` | The units of the value |
111-
| `${info}` | A short description of the alarm |
112-
| `${value_string}` | Friendly value (with units) |
113-
| `${old_value_string}` | Friendly old value (with units) |
114-
| `${image}` | The URL of an image to represent the status of the alarm |
115-
| `${color}` | A color in AABBCC format for the alarm |
116-
| `${goto_url}` | The URL the user can click to see the netdata dashboard |
117-
| `${calc_expression}` | The expression evaluated to provide the value for the alarm |
118-
| `${calc_param_values}` | The value of the variables in the evaluated expression |
119-
| `${total_warnings}` | The total number of alarms in WARNING state on the host |
120-
| `${total_critical}` | The total number of alarms in CRITICAL state on the host |
88+
| `$\{alarm}` | Like "name = value units" |
89+
| `$\{status_message}` | Like "needs attention", "recovered", "is critical" |
90+
| `$\{severity}` | Like "Escalated to CRITICAL", "Recovered from WARNING" |
91+
| `$\{raised_for}` | Like "(alarm was raised for 10 minutes)" |
92+
| `$\{host}` | The host generated this event |
93+
| `$\{url_host}` | Same as $\{host} but URL encoded |
94+
| `$\{unique_id}` | The unique id of this event |
95+
| `$\{alarm_id}` | The unique id of the alarm that generated this event |
96+
| `$\{event_id}` | The incremental id of the event, for this alarm id |
97+
| `$\{when}` | The timestamp this event occurred |
98+
| `$\{name}` | The name of the alarm, as given in netdata health.d entries |
99+
| `$\{url_name}` | Same as $\{name} but URL encoded |
100+
| `$\{chart}` | The name of the chart (type.id) |
101+
| `$\{url_chart}` | Same as $\{chart} but URL encoded |
102+
| `$\{status}` | The current status : REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL |
103+
| `$\{old_status}` | The previous status: REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL |
104+
| `$\{value}` | The current value of the alarm |
105+
| `$\{old_value}` | The previous value of the alarm |
106+
| `$\{src}` | The line number and file the alarm has been configured |
107+
| `$\{duration}` | The duration in seconds of the previous alarm state |
108+
| `$\{duration_txt}` | Same as $\{duration} for humans |
109+
| `$\{non_clear_duration}` | The total duration in seconds this is/was non-clear |
110+
| `$\{non_clear_duration_txt}` | Same as $\{non_clear_duration} for humans |
111+
| `$\{units}` | The units of the value |
112+
| `$\{info}` | A short description of the alarm |
113+
| `$\{value_string}` | Friendly value (with units) |
114+
| `$\{old_value_string}` | Friendly old value (with units) |
115+
| `$\{image}` | The URL of an image to represent the status of the alarm |
116+
| `$\{color}` | A color in AABBCC format for the alarm |
117+
| `$\{goto_url}` | The URL the user can click to see the netdata dashboard |
118+
| `$\{calc_expression}` | The expression evaluated to provide the value for the alarm |
119+
| `$\{calc_param_values}` | The value of the variables in the evaluated expression |
120+
| `$\{total_warnings}` | The total number of alarms in WARNING state on the host |
121+
| `$\{total_critical}` | The total number of alarms in CRITICAL state on the host |
121122

122123

123124
##### DEFAULT_RECIPIENT_AWSSNS
@@ -150,7 +151,7 @@ An example working configuration would be:
150151
# Amazon SNS notifications
151152
152153
SEND_AWSSNS="YES"
153-
AWSSNS_MESSAGE_FORMAT="${status} on ${host} at ${date}: ${chart} ${value_string}"
154+
AWSSNS_MESSAGE_FORMAT="$\{status} on $\{host} at $\{date}: $\{chart} $\{value_string}"
154155
DEFAULT_RECIPIENT_AWSSNS="arn:aws:sns:us-east-2:123456789012:MyTopic"
155156
```
156157

0 commit comments

Comments
 (0)