summaryrefslogtreecommitdiffstats
path: root/health/notifications
diff options
context:
space:
mode:
authorShyam Sreevalsan <shyam@netdata.cloud>2023-08-01 15:58:59 +0300
committerGitHub <noreply@github.com>2023-08-01 15:58:59 +0300
commit9b461c49ea82a006ccaba7d48046c611eae8f384 (patch)
tree081eb8cc50278451befe5efd9313e9e64869759e /health/notifications
parent995e3843226a5e1fbb667a9d5f6e469352f7bd85 (diff)
Fix formatting (#15673)
* Fix formatting * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * Update metadata.yaml * change block style to `|` for detailed_description --------- Co-authored-by: ilyam8 <ilya@netdata.cloud>
Diffstat (limited to 'health/notifications')
-rw-r--r--health/notifications/alerta/metadata.yaml6
-rw-r--r--health/notifications/awssns/metadata.yaml4
-rw-r--r--health/notifications/custom/metadata.yaml14
-rw-r--r--health/notifications/discord/metadata.yaml4
-rw-r--r--health/notifications/dynatrace/metadata.yaml4
-rw-r--r--health/notifications/email/metadata.yaml4
-rw-r--r--health/notifications/flock/metadata.yaml4
-rw-r--r--health/notifications/irc/metadata.yaml12
-rw-r--r--health/notifications/kavenegar/metadata.yaml4
-rw-r--r--health/notifications/matrix/metadata.yaml14
-rw-r--r--health/notifications/messagebird/metadata.yaml4
-rw-r--r--health/notifications/msteams/metadata.yaml9
-rw-r--r--health/notifications/ntfy/metadata.yaml8
-rw-r--r--health/notifications/pagerduty/metadata.yaml4
-rw-r--r--health/notifications/prowl/metadata.yaml4
-rw-r--r--health/notifications/pushbullet/metadata.yaml4
-rw-r--r--health/notifications/pushover/metadata.yaml4
-rw-r--r--health/notifications/rocketchat/metadata.yaml4
-rw-r--r--health/notifications/smstools3/metadata.yaml6
-rw-r--r--health/notifications/syslog/metadata.yaml6
-rw-r--r--health/notifications/telegram/metadata.yaml4
-rw-r--r--health/notifications/twilio/metadata.yaml4
22 files changed, 64 insertions, 67 deletions
diff --git a/health/notifications/alerta/metadata.yaml b/health/notifications/alerta/metadata.yaml
index 6bd3cffbcf..550963a15c 100644
--- a/health/notifications/alerta/metadata.yaml
+++ b/health/notifications/alerta/metadata.yaml
@@ -43,7 +43,7 @@
default_value: ''
description: "Set `ALERTA_API_KEY` to your API key."
required: true
- detailed_description: >
+ detailed_description: |
You will need an API key to send messages from any source, if Alerta is configured to use authentication (recommended). To create a new API key:
1. Go to Configuration > API Keys.
2. Create a new API key called "netdata" with `write:alerts` permission.
@@ -55,10 +55,10 @@
default_value: ''
description: "Set different recipient environments per role, by editing `DEFAULT_RECIPIENT_CUSTOM` with the environment name of your choice"
required: false
- detailed_description: >
+ detailed_description: |
The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_alerta[sysadmin]="Systems"
role_recipients_alerta[domainadmin]="Domains"
role_recipients_alerta[dba]="Databases Systems"
diff --git a/health/notifications/awssns/metadata.yaml b/health/notifications/awssns/metadata.yaml
index 1058f82119..2761feb8ed 100644
--- a/health/notifications/awssns/metadata.yaml
+++ b/health/notifications/awssns/metadata.yaml
@@ -56,7 +56,7 @@
default_value: '${status} on ${host} at ${date}: ${chart} ${value_string}'
description: "Set `AWSSNS_MESSAGE_FORMAT` to to the string that you want the alert to be sent into."
required: true
- detailed_description: >
+ detailed_description: |
The supported variables are:
| Variable name | Description |
@@ -101,7 +101,7 @@
default_value: ''
description: "Set `DEFAULT_RECIPIENT_AWSSNS` to the Topic ARN you noted down upon creating the Topic."
required: true
- detailed_description: >
+ detailed_description: |
All roles will default to this variable if left unconfigured.
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:
diff --git a/health/notifications/custom/metadata.yaml b/health/notifications/custom/metadata.yaml
index dc92f8c14c..40906268c7 100644
--- a/health/notifications/custom/metadata.yaml
+++ b/health/notifications/custom/metadata.yaml
@@ -36,10 +36,9 @@
default_value: ''
description: "This value is dependent on how you handle the `${to}` variable inside the `custom_sender()` function."
required: true
- detailed_description: >
- 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
+ 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:
+ ```
role_recipients_custom[sysadmin]="systems"
role_recipients_custom[domainadmin]="domains"
role_recipients_custom[dba]="databases systems"
@@ -51,10 +50,9 @@
default_value: ''
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:
-
- ```sh
+ 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:
+ ```
custom_sender() {
# example human readable SMS
local msg="${host} ${status_message}: ${alarm} ${raised_for}"
diff --git a/health/notifications/discord/metadata.yaml b/health/notifications/discord/metadata.yaml
index 7af6bdeada..713ec52ef8 100644
--- a/health/notifications/discord/metadata.yaml
+++ b/health/notifications/discord/metadata.yaml
@@ -42,10 +42,10 @@
default_value: ''
description: "Set `DEFAULT_RECIPIENT_DISCORD` to the channel you want the alert notifications to be sent to. You can define multiple channels like this: `alerts` `systems`. "
required: true
- detailed_description: >
+ detailed_description: |
All roles will default to this variable if left unconfigured.
You can then have different channels per role, by editing `DEFAULT_RECIPIENT_DISCORD` with the channel you want, in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_discord[sysadmin]="systems"
role_recipients_discord[domainadmin]="domains"
role_recipients_discord[dba]="databases systems"
diff --git a/health/notifications/dynatrace/metadata.yaml b/health/notifications/dynatrace/metadata.yaml
index abf8cf1b5e..560bab759d 100644
--- a/health/notifications/dynatrace/metadata.yaml
+++ b/health/notifications/dynatrace/metadata.yaml
@@ -49,7 +49,7 @@
default_value: ''
description: "Set `DYNATRACE_SPACE` to the API Space, it is the URL part of the page you have access in order to generate the API Token."
required: true
- detailed_description: >
+ detailed_description: |
For example, the URL for a generated API token might look like: https://monitor.illumineit.com/e/2a93fe0e-4cd5-469a-9d0d-1a064235cfce/#settings/integration/apikeys;gf=all In that case, the Space is 2a93fe0e-4cd5-469a-9d0d-1a064235cfce.
- name: 'DYNATRACE_TAG_VALUE'
default_value: ''
@@ -63,7 +63,7 @@
default_value: 'Netdata Alarm'
description: "Set `DYNATRACE_EVENT` to the Dynatrace eventType you want."
required: false
- detailed_description: >
+ detailed_description: |
`AVAILABILITY_EVENT`, `CUSTOM_ALERT`, `CUSTOM_ANNOTATION`, `CUSTOM_CONFIGURATION`, `CUSTOM_DEPLOYMENT`, `CUSTOM_INFO`, `ERROR_EVENT`,
`MARKED_FOR_TERMINATION`, `PERFORMANCE_EVENT`, `RESOURCE_CONTENTION_EVENT`.
You can read more [here](https://www.dynatrace.com/support/help/dynatrace-api/environment-api/events-v2/post-event#request-body-objects).
diff --git a/health/notifications/email/metadata.yaml b/health/notifications/email/metadata.yaml
index 7edfdaac26..2619142dc5 100644
--- a/health/notifications/email/metadata.yaml
+++ b/health/notifications/email/metadata.yaml
@@ -41,10 +41,10 @@
default_value: 'root'
description: "Set `DEFAULT_RECIPIENT_EMAIL` to the email address you want the email to be sent by default. You can define multiple email addresses like this: `alarms@example.com` `systems@example.com`."
required: true
- detailed_description: >
+ detailed_description: |
All roles will default to this variable if left unconfigured.
The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_email[sysadmin]="systems@example.com"
role_recipients_email[domainadmin]="domains@example.com"
role_recipients_email[dba]="databases@example.com systems@example.com"
diff --git a/health/notifications/flock/metadata.yaml b/health/notifications/flock/metadata.yaml
index 26bdd1ec6f..8fd06e3e3b 100644
--- a/health/notifications/flock/metadata.yaml
+++ b/health/notifications/flock/metadata.yaml
@@ -41,9 +41,9 @@
default_value: ''
description: "Set `DEFAULT_RECIPIENT_FLOCK` to the Flock channel you want the alert notifications to be sent to. All roles will default to this variable if left unconfigured."
required: true
- detailed_description: >
+ detailed_description: |
You can have different channels per role, by editing DEFAULT_RECIPIENT_FLOCK with the channel you want, in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_flock[sysadmin]="systems"
role_recipients_flock[domainadmin]="domains"
role_recipients_flock[dba]="databases systems"
diff --git a/health/notifications/irc/metadata.yaml b/health/notifications/irc/metadata.yaml
index b88c9a5ae2..d483d2cb34 100644
--- a/health/notifications/irc/metadata.yaml
+++ b/health/notifications/irc/metadata.yaml
@@ -33,7 +33,8 @@
default_value: ''
description: "Set the path for nc, otherwise Netdata will search for it in your system $PATH"
required: true
- detailed_description: >
+ detailed_description: |
+ ```sh
#------------------------------------------------------------------------------
# external commands
#
@@ -41,14 +42,11 @@
# If empty, the system $PATH will be searched for it.
# If not found, irc notifications will be silently disabled.
nc="/usr/bin/nc"
+ ```
- name: 'SEND_IRC'
default_value: 'YES'
description: "Set `SEND_IRC` YES."
required: true
- - name: 'DEFAULT_RECIPIENT_IRC'
- default_value: ''
- description: "Set `DEFAULT_RECIPIENT_IRC` to one or more channels to post the messages to. You can define multiple channels like this: `#alarms` `#systems`."
- required: true
- name: 'IRC_NETWORK'
default_value: ''
description: "Set `IRC_NETWORK` to the IRC network which your preferred channels belong to."
@@ -69,9 +67,9 @@
default_value: ''
description: "You can have different channels per role, by editing `DEFAULT_RECIPIENT_IRC` with the channel you want"
required: true
- detailed_description: >
+ detailed_description: |
The `DEFAULT_RECIPIENT_IRC` can be edited in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_irc[sysadmin]="#systems"
role_recipients_irc[domainadmin]="#domains"
role_recipients_irc[dba]="#databases #systems"
diff --git a/health/notifications/kavenegar/metadata.yaml b/health/notifications/kavenegar/metadata.yaml
index d62126a1d1..53b55c9d71 100644
--- a/health/notifications/kavenegar/metadata.yaml
+++ b/health/notifications/kavenegar/metadata.yaml
@@ -46,11 +46,11 @@
default_value: ''
description: "Set `DEFAULT_RECIPIENT_KAVENEGAR` to the SMS recipient you want the alert notifications to be sent to. You can define multiple recipients like this: 09155555555 09177777777."
required: true
- detailed_description: >
+ detailed_description: |
All roles will default to this variable if lest unconfigured.
You can then have different SMS recipients per role, by editing `DEFAULT_RECIPIENT_KAVENEGAR` with the SMS recipients you want, in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_kavenegar[sysadmin]="09100000000"
role_recipients_kavenegar[domainadmin]="09111111111"
role_recipients_kavenegar[dba]="0922222222"
diff --git a/health/notifications/matrix/metadata.yaml b/health/notifications/matrix/metadata.yaml
index 5c5df88b8e..675ee1dbab 100644
--- a/health/notifications/matrix/metadata.yaml
+++ b/health/notifications/matrix/metadata.yaml
@@ -43,7 +43,7 @@
default_value: ''
description: "Set `MATRIX_ACCESSTOKEN` to the access token from your Matrix account."
required: true
- detailed_description: >
+ detailed_description: |
To obtain the access token, you can use the following curl command:
```
curl -XPOST -d '{"type":"m.login.password", "user":"example", "password":"wordpass"}' "https://homeserver:8448/_matrix/client/r0/login"
@@ -52,16 +52,16 @@
default_value: ''
description: "Set `DEFAULT_RECIPIENT_MATRIX` to the rooms you want the alert notifications to be sent to. The format is `!roomid:homeservername`."
required: true
- detailed_description: >
+ detailed_description: |
The room ids are unique identifiers and can be obtained from the room settings in a Matrix client (e.g. Riot).
- You can define multiple rooms like this: !roomid1:homeservername `!roomid2:homeservername`.
+
+ You can define multiple rooms like this: `!roomid1:homeservername` `!roomid2:homeservername`.
+
All roles will default to this variable if left unconfigured.
- Detailed information about the Matrix client API is available at the official site.
+ You can have different rooms per role, by editing `DEFAULT_RECIPIENT_MATRIX` with the `!roomid:homeservername` you want, in the following entries at the bottom of the same file:
- You can then have different rooms per role, by editing DEFAULT_RECIPIENT_MATRIX with the !roomid:homeservername you want, in the following entries at the bottom of the same file:
-
- ```
+ ```conf
role_recipients_matrix[sysadmin]="!roomid1:homeservername"
role_recipients_matrix[domainadmin]="!roomid2:homeservername"
role_recipients_matrix[dba]="!roomid3:homeservername"
diff --git a/health/notifications/messagebird/metadata.yaml b/health/notifications/messagebird/metadata.yaml
index 3ff194360e..2a53f05c23 100644
--- a/health/notifications/messagebird/metadata.yaml
+++ b/health/notifications/messagebird/metadata.yaml
@@ -45,11 +45,11 @@
default_value: ''
description: "Set `DEFAULT_RECIPIENT_MESSAGEBIRD` to the number you want the alert notification to be sent as an SMS. You can define multiple recipients like this: +15555555555 +17777777777."
required: true
- detailed_description: >
+ detailed_description: |
All roles will default to this variable if left unconfigured.
You can then have different recipients per role, by editing `DEFAULT_RECIPIENT_MESSAGEBIRD` with the number you want, in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_messagebird[sysadmin]="+15555555555"
role_recipients_messagebird[domainadmin]="+15555555556"
role_recipients_messagebird[dba]="+15555555557"
diff --git a/health/notifications/msteams/metadata.yaml b/health/notifications/msteams/metadata.yaml
index 17400237eb..cc2b9ccba0 100644
--- a/health/notifications/msteams/metadata.yaml
+++ b/health/notifications/msteams/metadata.yaml
@@ -44,12 +44,13 @@
default_value: ''
description: "Set `DEFAULT_RECIPIENT_MSTEAMS` to the encoded Microsoft Teams channel name you want the alert notifications to be sent to."
required: true
- detailed_description: >
- In Microsoft Teams the channel name is encoded in the URI after /IncomingWebhook/. You can define multiple channels like this: CHANNEL1 CHANNEL2.
+ detailed_description: |
+ In Microsoft Teams the channel name is encoded in the URI after `/IncomingWebhook/`. You can define multiple channels like this: `CHANNEL1` `CHANNEL2`.
+
All roles will default to this variable if left unconfigured.
- You can then have different channels per role, by editing `DEFAULT_RECIPIENT_MSTEAMS` with the channel you want, in the following entries at the bottom of the same file:
- ```
+ You can have different channels per role, by editing `DEFAULT_RECIPIENT_MSTEAMS` with the channel you want, in the following entries at the bottom of the same file:
+ ```conf
role_recipients_msteams[sysadmin]="CHANNEL1"
role_recipients_msteams[domainadmin]="CHANNEL2"
role_recipients_msteams[dba]="databases CHANNEL3"
diff --git a/health/notifications/ntfy/metadata.yaml b/health/notifications/ntfy/metadata.yaml
index e72a258f2b..86201d1ff6 100644
--- a/health/notifications/ntfy/metadata.yaml
+++ b/health/notifications/ntfy/metadata.yaml
@@ -37,15 +37,15 @@
required: true
- name: 'DEFAULT_RECIPIENT_NTFY'
default_value: ''
- description: "Set `DEFAULT_RECIPIENT_NTFY` to the URL formed by the server-topic combination you want the alert notifications to be sent to. Unless you are hosting your own server, the server should always be set to https://ntfy.sh."
+ description: "URL formed by the server-topic combination you want the alert notifications to be sent to. Unless hosting your own server, the server should always be set to https://ntfy.sh."
required: true
- detailed_description: >
- You can define multiple recipient URLs like this: https://SERVER1/TOPIC1 https://SERVER2/TOPIC2
+ detailed_description: |
+ You can define multiple recipient URLs like this: `https://SERVER1/TOPIC1` `https://SERVER2/TOPIC2`
All roles will default to this variable if left unconfigured.
You can then have different servers and/or topics per role, by editing DEFAULT_RECIPIENT_NTFY with the server-topic combination you want, in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_ntfy[sysadmin]="https://SERVER1/TOPIC1"
role_recipients_ntfy[domainadmin]="https://SERVER2/TOPIC2"
role_recipients_ntfy[dba]="https://SERVER3/TOPIC3"
diff --git a/health/notifications/pagerduty/metadata.yaml b/health/notifications/pagerduty/metadata.yaml
index 1fe0954f02..3785314ad3 100644
--- a/health/notifications/pagerduty/metadata.yaml
+++ b/health/notifications/pagerduty/metadata.yaml
@@ -40,11 +40,11 @@
default_value: ''
description: "Set `DEFAULT_RECIPIENT_PD` to the PagerDuty service key you want the alert notifications to be sent to. You can define multiple service keys like this: `pd_service_key_1` `pd_service_key_2`."
required: true
- detailed_description: >
+ detailed_description: |
All roles will default to this variable if left unconfigured.
The `DEFAULT_RECIPIENT_PD` can be edited in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_pd[sysadmin]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxa"
role_recipients_pd[domainadmin]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxb"
role_recipients_pd[dba]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxc"
diff --git a/health/notifications/prowl/metadata.yaml b/health/notifications/prowl/metadata.yaml
index 74e2dc7168..7c04b305a6 100644
--- a/health/notifications/prowl/metadata.yaml
+++ b/health/notifications/prowl/metadata.yaml
@@ -39,11 +39,11 @@
default_value: ''
description: "Set `DEFAULT_RECIPIENT_PROWL` to the Prowl API key you want the alert notifications to be sent to. You can define multiple API keys like this: `APIKEY1`, `APIKEY2`."
required: true
- detailed_description: >
+ detailed_description: |
All roles will default to this variable if left unconfigured.
The `DEFAULT_RECIPIENT_PROWL` can be edited in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_prowl[sysadmin]="AAAAAAAA"
role_recipients_prowl[domainadmin]="BBBBBBBBB"
role_recipients_prowl[dba]="CCCCCCCCC"
diff --git a/health/notifications/pushbullet/metadata.yaml b/health/notifications/pushbullet/metadata.yaml
index d8dabdc5b4..f1e4b71633 100644
--- a/health/notifications/pushbullet/metadata.yaml
+++ b/health/notifications/pushbullet/metadata.yaml
@@ -41,13 +41,13 @@
default_value: ''
description: "Set `DEFAULT_RECIPIENT_PUSHBULLET` to the email (e.g. `example@domain.com`) or the channel tag (e.g. `#channel`) you want the alert notifications to be sent to."
required: true
- detailed_description: >
+ detailed_description: |
You can define multiple entries like this: user1@email.com user2@email.com.
All roles will default to this variable if left unconfigured.
The `DEFAULT_RECIPIENT_PUSHBULLET` can be edited in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_pushbullet[sysadmin]="user1@email.com"
role_recipients_pushbullet[domainadmin]="user2@mail.com"
role_recipients_pushbullet[dba]="#channel1"
diff --git a/health/notifications/pushover/metadata.yaml b/health/notifications/pushover/metadata.yaml
index 18b8203068..65b440b9f7 100644
--- a/health/notifications/pushover/metadata.yaml
+++ b/health/notifications/pushover/metadata.yaml
@@ -45,11 +45,11 @@
default_value: ''
description: "Set `DEFAULT_RECIPIENT_PUSHOVER` the Pushover User token you want the alert notifications to be sent to. You can define multiple User tokens like this: `USERTOKEN1` `USERTOKEN2`."
required: true
- detailed_description: >
+ detailed_description: |
All roles will default to this variable if left unconfigured.
The `DEFAULT_RECIPIENT_PUSHOVER` can be edited in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_pushover[sysadmin]="USERTOKEN1"
role_recipients_pushover[domainadmin]="USERTOKEN2"
role_recipients_pushover[dba]="USERTOKEN3 USERTOKEN4"
diff --git a/health/notifications/rocketchat/metadata.yaml b/health/notifications/rocketchat/metadata.yaml
index 518f87bd39..969fd87872 100644
--- a/health/notifications/rocketchat/metadata.yaml
+++ b/health/notifications/rocketchat/metadata.yaml
@@ -42,11 +42,11 @@
default_value: ''
description: "Set `DEFAULT_RECIPIENT_ROCKETCHAT` to the channel you want the alert notifications to be sent to. You can define multiple channels like this: `alerts` `systems`."
required: true
- detailed_description: >
+ detailed_description: |
All roles will default to this variable if left unconfigured.
The `DEFAULT_RECIPIENT_ROCKETCHAT` can be edited in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_rocketchat[sysadmin]="systems"
role_recipients_rocketchat[domainadmin]="domains"
role_recipients_rocketchat[dba]="databases systems"
diff --git a/health/notifications/smstools3/metadata.yaml b/health/notifications/smstools3/metadata.yaml
index 5ee8f802bf..0f2051c4dd 100644
--- a/health/notifications/smstools3/metadata.yaml
+++ b/health/notifications/smstools3/metadata.yaml
@@ -40,7 +40,7 @@
default_value: 'YES'
description: "Set the path for `sendsms`, otherwise Netdata will search for it in your system `$PATH:`"
required: true
- detailed_description: >
+ detailed_description: |
# The full path of the sendsms command (smstools3).
# If empty, the system $PATH will be searched for it.
# If not found, SMS notifications will be silently disabled.
@@ -53,11 +53,11 @@
default_value: ''
description: "Set DEFAULT_RECIPIENT_SMS to the phone number you want the alert notifications to be sent to. You can define multiple phone numbers like this: PHONE1 PHONE2."
required: true
- detailed_description: >
+ detailed_description: |
All roles will default to this variable if left unconfigured.
You can then have different phone numbers per role, by editing `DEFAULT_RECIPIENT_SMS` with the phone number you want, in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_sms[sysadmin]="PHONE1"
role_recipients_sms[domainadmin]="PHONE2"
role_recipients_sms[dba]="PHONE3"
diff --git a/health/notifications/syslog/metadata.yaml b/health/notifications/syslog/metadata.yaml
index 32a5f0a7db..73723a0a37 100644
--- a/health/notifications/syslog/metadata.yaml
+++ b/health/notifications/syslog/metadata.yaml
@@ -37,7 +37,7 @@
default_value: ''
description: "Set `DEFAULT_RECIPIENT_SYSLOG` to the recipient you want the alert notifications to be sent to."
required: true
- detailed_description: >
+ detailed_description: |
Targets are defined as follows:
```
@@ -56,10 +56,10 @@
default_value: ''
description: "Set SEND_SYSLOG to YES, make sure you have everything else configured before turning this on."
required: true
- detailed_description: >
+ detailed_description: |
You can then have different recipients per role, by editing DEFAULT_RECIPIENT_SYSLOG with the recipient you want, in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_syslog[sysadmin]="daemon.notice@loghost1:514/netdata"
role_recipients_syslog[domainadmin]="daemon.notice@loghost2:514/netdata"
role_recipients_syslog[dba]="daemon.notice@loghost3:514/netdata"
diff --git a/health/notifications/telegram/metadata.yaml b/health/notifications/telegram/metadata.yaml
index 5e4321d6b2..c14cd352e1 100644
--- a/health/notifications/telegram/metadata.yaml
+++ b/health/notifications/telegram/metadata.yaml
@@ -43,12 +43,12 @@
default_value: ''
description: "Set `DEFAULT_RECIPIENT_TELEGRAM` to the chat ID you want the alert notifications to be sent to. You can define multiple chat IDs like this: 49999333322 -1009999222255."
required: true
- detailed_description: >
+ detailed_description: |
All roles will default to this variable if left unconfigured.
The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_telegram[sysadmin]="49999333324"
role_recipients_telegram[domainadmin]="49999333389"
role_recipients_telegram[dba]="-1009999222255"
diff --git a/health/notifications/twilio/metadata.yaml b/health/notifications/twilio/metadata.yaml
index 74a85bca13..0587901c4d 100644
--- a/health/notifications/twilio/metadata.yaml
+++ b/health/notifications/twilio/metadata.yaml
@@ -49,10 +49,10 @@
default_value: ''
description: "Set DEFAULT_RECIPIENT_TWILIO to the number you want the alert notifications to be sent to. You can define multiple numbers like this: +15555555555 +17777777777."
required: true
- detailed_description: >
+ detailed_description: |
You can then have different recipients per role, by editing DEFAULT_RECIPIENT_TWILIO with the recipient's number you want, in the following entries at the bottom of the same file:
- ```
+ ```conf
role_recipients_twilio[sysadmin]="+15555555555"
role_recipients_twilio[domainadmin]="+15555555556"
role_recipients_twilio[dba]="+15555555557"