Regenerate integrations docs (#22205)
Co-authored-by: Ancairon <70198089+Ancairon@users.noreply.github.com>
Netdata bot committed
Apr 14, 2026 at 08:41 UTC
762f6da6a39da3cafc54fc55ba88c028d49d8089
2 files changed
+4
-78
src/health/notifications/awssns/README.md
+3
-40
@@ -29,7 +29,7 @@ You can send notifications through Amazon SNS using Netdata's Agent alert notifi
29
## Limitations
30
31
- While Amazon SNS supports sending differently formatted messages for different delivery methods, Netdata does not currently support this functionality.
32
-- For email notification support, we recommend using Netdata's email notifications, as it is has the following benefits:
32
+- For email notification support, we recommend using Netdata's email notifications, as it has the following benefits:
33
- In most cases, it requires less configuration.
34
- Netdata's emails are nicely pre-formatted and support features like threading, which requires a lot of manual effort in SNS.
35
- It is less resource intensive and more cost-efficient than SNS.
@@ -64,50 +64,13 @@ The following options can be defined for this notification
64
|:-----|:------------|:--------|:---------:|
65
| 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 |
66
| SEND_AWSNS | Set `SEND_AWSNS` to YES | YES | yes |
67
-| [AWSSNS_MESSAGE_FORMAT](#option-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 |
67
+| [AWSSNS_MESSAGE_FORMAT](#option-awssns-message-format) | Set `AWSSNS_MESSAGE_FORMAT` to the string that you want the alert to be sent into. | ${status} on ${host} at ${date}: ${chart} ${value_string} | yes |
68
| [DEFAULT_RECIPIENT_AWSSNS](#option-default-recipient-awssns) | Set `DEFAULT_RECIPIENT_AWSSNS` to the Topic ARN you noted down upon creating the Topic. | | yes |
69
70
<a id="option-awssns-message-format"></a>
71
##### AWSSNS_MESSAGE_FORMAT
72
73
-The supported variables are:
74
-
75
-| Variable name | Description |
76
-|:---------------------------:|:---------------------------------------------------------------------------------|
77
-| `${alarm}` | Like "name = value units" |
78
-| `${status_message}` | Like "needs attention", "recovered", "is critical" |
79
-| `${severity}` | Like "Escalated to CRITICAL", "Recovered from WARNING" |
80
-| `${raised_for}` | Like "(alarm was raised for 10 minutes)" |
81
-| `${host}` | The host generated this event |
82
-| `${url_host}` | Same as ${host} but URL encoded |
83
-| `${unique_id}` | The unique id of this event |
84
-| `${alarm_id}` | The unique id of the alarm that generated this event |
85
-| `${event_id}` | The incremental id of the event, for this alarm id |
86
-| `${when}` | The timestamp this event occurred |
87
-| `${name}` | The name of the alarm, as given in netdata health.d entries |
88
-| `${url_name}` | Same as ${name} but URL encoded |
89
-| `${chart}` | The name of the chart (type.id) |
90
-| `${url_chart}` | Same as ${chart} but URL encoded |
91
-| `${status}` | The current status : REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL |
92
-| `${old_status}` | The previous status: REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL |
93
-| `${value}` | The current value of the alarm |
94
-| `${old_value}` | The previous value of the alarm |
95
-| `${src}` | The line number and file the alarm has been configured |
96
-| `${duration}` | The duration in seconds of the previous alarm state |
97
-| `${duration_txt}` | Same as ${duration} for humans |
98
-| `${non_clear_duration}` | The total duration in seconds this is/was non-clear |
99
-| `${non_clear_duration_txt}` | Same as ${non_clear_duration} for humans |
100
-| `${units}` | The units of the value |
101
-| `${info}` | A short description of the alarm |
102
-| `${value_string}` | Friendly value (with units) |
103
-| `${old_value_string}` | Friendly old value (with units) |
104
-| `${image}` | The URL of an image to represent the status of the alarm |
105
-| `${color}` | A color in AABBCC format for the alarm |
106
-| `${goto_url}` | The URL the user can click to see the netdata dashboard |
107
-| `${calc_expression}` | The expression evaluated to provide the value for the alarm |
108
-| `${calc_param_values}` | The value of the variables in the evaluated expression |
109
-| `${total_warnings}` | The total number of alarms in WARNING state on the host |
110
-| `${total_critical}` | The total number of alarms in CRITICAL state on the host |
73
+For the complete list of supported notification variables, see the [Alert Notification Variables](../../REFERENCE.md#alert-notification-variables) section in the Health Reference.
74
75
76
<a id="option-default-recipient-awssns"></a>
src/health/notifications/custom/README.md
+1
-38
@@ -93,44 +93,7 @@ custom_sender() {
93
}
94
```
95
96
-The supported variables that you can use for the function's `msg` variable are:
97
-
98
-| Variable name | Description |
99
-|:---------------------------:|:---------------------------------------------------------------------------------|
100
-| `${alarm}` | Like "name = value units" |
101
-| `${status_message}` | Like "needs attention", "recovered", "is critical" |
102
-| `${severity}` | Like "Escalated to CRITICAL", "Recovered from WARNING" |
103
-| `${raised_for}` | Like "(alarm was raised for 10 minutes)" |
104
-| `${host}` | The host generated this event |
105
-| `${url_host}` | Same as ${host} but URL encoded |
106
-| `${unique_id}` | The unique id of this event |
107
-| `${alarm_id}` | The unique id of the alarm that generated this event |
108
-| `${event_id}` | The incremental id of the event, for this alarm id |
109
-| `${when}` | The timestamp this event occurred |
110
-| `${name}` | The name of the alarm, as given in netdata health.d entries |
111
-| `${url_name}` | Same as ${name} but URL encoded |
112
-| `${chart}` | The name of the chart (type.id) |
113
-| `${url_chart}` | Same as ${chart} but URL encoded |
114
-| `${status}` | The current status : REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL |
115
-| `${old_status}` | The previous status: REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL |
116
-| `${value}` | The current value of the alarm |
117
-| `${old_value}` | The previous value of the alarm |
118
-| `${src}` | The line number and file the alarm has been configured |
119
-| `${duration}` | The duration in seconds of the previous alarm state |
120
-| `${duration_txt}` | Same as ${duration} for humans |
121
-| `${non_clear_duration}` | The total duration in seconds this is/was non-clear |
122
-| `${non_clear_duration_txt}` | Same as ${non_clear_duration} for humans |
123
-| `${units}` | The units of the value |
124
-| `${info}` | A short description of the alarm |
125
-| `${value_string}` | Friendly value (with units) |
126
-| `${old_value_string}` | Friendly old value (with units) |
127
-| `${image}` | The URL of an image to represent the status of the alarm |
128
-| `${color}` | A color in AABBCC format for the alarm |
129
-| `${goto_url}` | The URL the user can click to see the netdata dashboard |
130
-| `${calc_expression}` | The expression evaluated to provide the value for the alarm |
131
-| `${calc_param_values}` | The value of the variables in the evaluated expression |
132
-| `${total_warnings}` | The total number of alarms in WARNING state on the host |
133
-| `${total_critical}` | The total number of alarms in CRITICAL state on the host |
96
+For the complete list of supported notification variables, see the [Alert Notification Variables](../../REFERENCE.md#alert-notification-variables) section in the Health Reference.
97
98
99