diff options
| author | Shyam Sreevalsan <shyam@netdata.cloud> | 2023-08-01 15:38:03 +0300 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-08-01 15:38:03 +0300 |
| commit | 07985335e3f1c5b2e633064133a394d837c83290 (patch) | |
| tree | 465e926159d2ebdc8985a1da36b845715d06b2db /health/notifications | |
| parent | 426cf005a3687bcb85b5606b8bae5f08543b2ca0 (diff) | |
Fix table formatting (custom exporter) (#15668)
* Fix table formatting (custom exporter)
* Update metadata.yaml
* Update metadata.yaml
Diffstat (limited to 'health/notifications')
| -rw-r--r-- | health/notifications/custom/metadata.yaml | 95 |
1 files changed, 49 insertions, 46 deletions
diff --git a/health/notifications/custom/metadata.yaml b/health/notifications/custom/metadata.yaml index 5b044c9cf6..dc92f8c14c 100644 --- a/health/notifications/custom/metadata.yaml +++ b/health/notifications/custom/metadata.yaml @@ -34,11 +34,12 @@ required: true - name: 'DEFAULT_RECIPIENT_CUSTOM' default_value: '' - description: "The `DEFAULT_RECIPIENT_CUSTOM` value is dependent on how you handle the `${to}` variable inside the `custom_sender()` function." + description: "This value is dependent on how you handle the `${to}` variable inside the `custom_sender()` function." required: true detailed_description: > - All roles will default to this variable if left unconfigured. You can edit `DEFAULT_RECIPIENT_CUSTOM` with the variable you want, in the following entries at the bottom of the same file: - ``` + You can have different `${to}` variables per **role**, by editing `DEFAULT_RECIPIENT_CUSTOM` with the variable you want, in the following entries at the bottom of the file: + + ```conf role_recipients_custom[sysadmin]="systems" role_recipients_custom[domainadmin]="domains" role_recipients_custom[dba]="databases systems" @@ -51,8 +52,9 @@ description: "You can look at the other senders in `/usr/libexec/netdata/plugins.d/alarm-notify.sh` for examples of how to modify the function in this configuration file." required: false detailed_description: > - The following is a sample custom_sender() function in health_alarm_notify.conf, to send an SMS via an imaginary HTTPS endpoint to the SMS gateway: - ``` + The following is a sample `custom_sender()` function in `health_alarm_notify.conf`, to send an SMS via an imaginary HTTPS endpoint to the SMS gateway: + + ```sh custom_sender() { # example human readable SMS local msg="${host} ${status_message}: ${alarm} ${raised_for}" @@ -62,7 +64,7 @@ # a space separated list of the recipients to send alarms to to="${1}" - + for phone in ${to}; do httpcode=$(docurl -X POST \ --data-urlencode "From=XXX" \ @@ -80,46 +82,47 @@ done } ``` - The supported variables that you can use for the function's msg variable are: - ``` - Variable name Description - ${alarm} Like "name = value units" - ${status_message} Like "needs attention", "recovered", "is critical" - ${severity} Like "Escalated to CRITICAL", "Recovered from WARNING" - ${raised_for} Like "(alarm was raised for 10 minutes)" - ${host} The host generated this event - ${url_host} Same as ${host} but URL encoded - ${unique_id} The unique id of this event - ${alarm_id} The unique id of the alarm that generated this event - ${event_id} The incremental id of the event, for this alarm id - ${when} The timestamp this event occurred - ${name} The name of the alarm, as given in netdata health.d entries - ${url_name} Same as ${name} but URL encoded - ${chart} The name of the chart (type.id) - ${url_chart} Same as ${chart} but URL encoded - ${family} The family of the chart - ${url_family} Same as ${family} but URL encoded - ${status} The current status : REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL - ${old_status} The previous status: REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL - ${value} The current value of the alarm - ${old_value} The previous value of the alarm - ${src} The line number and file the alarm has been configured - ${duration} The duration in seconds of the previous alarm state - ${duration_txt} Same as ${duration} for humans - ${non_clear_duration} The total duration in seconds this is/was non-clear - ${non_clear_duration_txt} Same as ${non_clear_duration} for humans - ${units} The units of the value - ${info} A short description of the alarm - ${value_string} Friendly value (with units) - ${old_value_string} Friendly old value (with units) - ${image} The URL of an image to represent the status of the alarm - ${color} A color in AABBCC format for the alarm - ${goto_url} The URL the user can click to see the netdata dashboard - ${calc_expression} The expression evaluated to provide the value for the alarm - ${calc_param_values} The value of the variables in the evaluated expression - ${total_warnings} The total number of alarms in WARNING state on the host - ${total_critical} The total number of alarms in CRITICAL state on the host - ``` + + The supported variables that you can use for the function's `msg` variable are: + + | Variable name | Description | + |:---------------------------:|:---------------------------------------------------------------------------------| + | `${alarm}` | Like "name = value units" | + | `${status_message}` | Like "needs attention", "recovered", "is critical" | + | `${severity}` | Like "Escalated to CRITICAL", "Recovered from WARNING" | + | `${raised_for}` | Like "(alarm was raised for 10 minutes)" | + | `${host}` | The host generated this event | + | `${url_host}` | Same as ${host} but URL encoded | + | `${unique_id}` | The unique id of this event | + | `${alarm_id}` | The unique id of the alarm that generated this event | + | `${event_id}` | The incremental id of the event, for this alarm id | + | `${when}` | The timestamp this event occurred | + | `${name}` | The name of the alarm, as given in netdata health.d entries | + | `${url_name}` | Same as ${name} but URL encoded | + | `${chart}` | The name of the chart (type.id) | + | `${url_chart}` | Same as ${chart} but URL encoded | + | `${family}` | The family of the chart | + | `${url_family}` | Same as ${family} but URL encoded | + | `${status}` | The current status : REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL | + | `${old_status}` | The previous status: REMOVED, UNINITIALIZED, UNDEFINED, CLEAR, WARNING, CRITICAL | + | `${value}` | The current value of the alarm | + | `${old_value}` | The previous value of the alarm | + | `${src}` | The line number and file the alarm has been configured | + | `${duration}` | The duration in seconds of the previous alarm state | + | `${duration_txt}` | Same as ${duration} for humans | + | `${non_clear_duration}` | The total duration in seconds this is/was non-clear | + | `${non_clear_duration_txt}` | Same as ${non_clear_duration} for humans | + | `${units}` | The units of the value | + | `${info}` | A short description of the alarm | + | `${value_string}` | Friendly value (with units) | + | `${old_value_string}` | Friendly old value (with units) | + | `${image}` | The URL of an image to represent the status of the alarm | + | `${color}` | A color in AABBCC format for the alarm | + | `${goto_url}` | The URL the user can click to see the netdata dashboard | + | `${calc_expression}` | The expression evaluated to provide the value for the alarm | + | `${calc_param_values}` | The value of the variables in the evaluated expression | + | `${total_warnings}` | The total number of alarms in WARNING state on the host | + | `${total_critical}` | The total number of alarms in CRITICAL state on the host | examples: folding: enabled: true |