Fixing tables (aws sns) (#15671)
Update metadata.yaml
Shyam Sreevalsan committed
Aug 1, 2023 at 15:29 UTC
426cf005a3687bcb85b5606b8bae5f08543b2ca0
1 file changed
+47
-40
health/notifications/awssns/metadata.yaml
+47
-40
@@ -58,51 +58,54 @@
58
required: true
59
detailed_description: >
60
The supported variables are:
61
- Variable name Description
62
- ${alarm} Like "name = value units"
63
- ${status_message} Like "needs attention", "recovered", "is critical"
64
- ${severity} Like "Escalated to CRITICAL", "Recovered from WARNING"
65
- ${raised_for} Like "(alarm was raised for 10 minutes)"
66
- ${host} The host generated this event
67
- ${url_host} Same as ${host} but URL encoded
68
- ${unique_id} The unique id of this event
69
- ${alarm_id} The unique id of the alarm that generated this event
70
- ${event_id} The incremental id of the event, for this alarm id
71
- ${when} The timestamp this event occurred
72
- ${name} The name of the alarm, as given in netdata health.d entries
73
- ${url_name} Same as ${name} but URL encoded
74
- ${chart} The name of the chart (type.id)
75
- ${url_chart} Same as ${chart} but URL encoded
76
- ${family} The family of the chart
77
- ${url_family} Same as ${family} but URL encoded
78
- ${status} The current status : REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL
79
- ${old_status} The previous status: REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL
80
- ${value} The current value of the alarm
81
- ${old_value} The previous value of the alarm
82
- ${src} The line number and file the alarm has been configured
83
- ${duration} The duration in seconds of the previous alarm state
84
- ${duration_txt} Same as ${duration} for humans
85
- ${non_clear_duration} The total duration in seconds this is/was non-clear
86
- ${non_clear_duration_txt} Same as ${non_clear_duration} for humans
87
- ${units} The units of the value
88
- ${info} A short description of the alarm
89
- ${value_string} Friendly value (with units)
90
- ${old_value_string} Friendly old value (with units)
91
- ${image} The URL of an image to represent the status of the alarm
92
- ${color} A color in AABBCC format for the alarm
93
- ${goto_url} The URL the user can click to see the netdata dashboard
94
- ${calc_expression} The expression evaluated to provide the value for the alarm
95
- ${calc_param_values} The value of the variables in the evaluated expression
96
- ${total_warnings} The total number of alarms in WARNING state on the host
97
- ${total_critical} The total number of alarms in CRITICAL state on the host
61
+
62
+ | Variable name | Description |
63
+ |:---------------------------:|:---------------------------------------------------------------------------------|
64
+ | `${alarm}` | Like "name = value units" |
65
+ | `${status_message}` | Like "needs attention", "recovered", "is critical" |
66
+ | `${severity}` | Like "Escalated to CRITICAL", "Recovered from WARNING" |
67
+ | `${raised_for}` | Like "(alarm was raised for 10 minutes)" |
68
+ | `${host}` | The host generated this event |
69
+ | `${url_host}` | Same as ${host} but URL encoded |
70
+ | `${unique_id}` | The unique id of this event |
71
+ | `${alarm_id}` | The unique id of the alarm that generated this event |
72
+ | `${event_id}` | The incremental id of the event, for this alarm id |
73
+ | `${when}` | The timestamp this event occurred |
74
+ | `${name}` | The name of the alarm, as given in netdata health.d entries |
75
+ | `${url_name}` | Same as ${name} but URL encoded |
76
+ | `${chart}` | The name of the chart (type.id) |
77
+ | `${url_chart}` | Same as ${chart} but URL encoded |
78
+ | `${family}` | The family of the chart |
79
+ | `${url_family}` | Same as ${family} but URL encoded |
80
+ | `${status}` | The current status : REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL |
81
+ | `${old_status}` | The previous status: REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL |
82
+ | `${value}` | The current value of the alarm |
83
+ | `${old_value}` | The previous value of the alarm |
84
+ | `${src}` | The line number and file the alarm has been configured |
85
+ | `${duration}` | The duration in seconds of the previous alarm state |
86
+ | `${duration_txt}` | Same as ${duration} for humans |
87
+ | `${non_clear_duration}` | The total duration in seconds this is/was non-clear |
88
+ | `${non_clear_duration_txt}` | Same as ${non_clear_duration} for humans |
89
+ | `${units}` | The units of the value |
90
+ | `${info}` | A short description of the alarm |
91
+ | `${value_string}` | Friendly value (with units) |
92
+ | `${old_value_string}` | Friendly old value (with units) |
93
+ | `${image}` | The URL of an image to represent the status of the alarm |
94
+ | `${color}` | A color in AABBCC format for the alarm |
95
+ | `${goto_url}` | The URL the user can click to see the netdata dashboard |
96
+ | `${calc_expression}` | The expression evaluated to provide the value for the alarm |
97
+ | `${calc_param_values}` | The value of the variables in the evaluated expression |
98
+ | `${total_warnings}` | The total number of alarms in WARNING state on the host |
99
+ | `${total_critical}` | The total number of alarms in CRITICAL state on the host |
100
- name: 'DEFAULT_RECIPIENT_AWSSNS'
101
default_value: ''
102
description: "Set `DEFAULT_RECIPIENT_AWSSNS` to the Topic ARN you noted down upon creating the Topic."
103
required: true
104
detailed_description: >
105
All roles will default to this variable if left unconfigured.
104
- The `DEFAULT_RECIPIENT_AWSSNS` can be edited in the following entries at the bottom of the same file:
105
- ```
106
+ You can have different recipient Topics per **role**, by editing `DEFAULT_RECIPIENT_AWSSNS` with the Topic ARN you want, in the following entries at the bottom of the same file:
107
+
108
+ ```conf
109
role_recipients_awssns[sysadmin]="arn:aws:sns:us-east-2:123456789012:Systems"
110
role_recipients_awssns[domainadmin]="arn:aws:sns:us-east-2:123456789012:Domains"
111
role_recipients_awssns[dba]="arn:aws:sns:us-east-2:123456789012:Databases"
@@ -118,10 +121,14 @@
121
- name: 'Basic Configuration'
122
folding:
123
enabled: false
121
- description: ''
124
+ description: 'An example working configuration would be:'
125
+ config: |
126
config: |
127
+ ```conf
128
#------------------------------------------------------------------------------
129
# Amazon SNS notifications
130
+
131
SEND_AWSSNS="YES"
132
AWSSNS_MESSAGE_FORMAT="${status} on ${host} at ${date}: ${chart} ${value_string}"
133
DEFAULT_RECIPIENT_AWSSNS="arn:aws:sns:us-east-2:123456789012:MyTopic"
134
+ ```