9b461c49e · cryptotaxi247/netdata-1

health/notifications/alerta/metadata.yaml

+3 -3

@@ -43,7 +43,7 @@

43 default_value: ''

44 description: "Set `ALERTA_API_KEY` to your API key."

45 required: true

46 - detailed_description: >

46 + detailed_description: |

47 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:

48 1. Go to Configuration > API Keys.

49 2. Create a new API key called "netdata" with `write:alerts` permission.

@@ -55,10 +55,10 @@

55 default_value: ''

56 description: "Set different recipient environments per role, by editing `DEFAULT_RECIPIENT_CUSTOM` with the environment name of your choice"

57 required: false

58 - detailed_description: >

58 + detailed_description: |

59 The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:

60

61 - ```

61 + ```conf

62 role_recipients_alerta[sysadmin]="Systems"

63 role_recipients_alerta[domainadmin]="Domains"

64 role_recipients_alerta[dba]="Databases Systems"

health/notifications/awssns/metadata.yaml

+2 -2

@@ -56,7 +56,7 @@

56 default_value: '${status} on ${host} at ${date}: ${chart} ${value_string}'

57 description: "Set `AWSSNS_MESSAGE_FORMAT` to to the string that you want the alert to be sent into."

58 required: true

59 - detailed_description: >

59 + detailed_description: |

60 The supported variables are:

61

62 | Variable name | Description |

@@ -101,7 +101,7 @@

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: >

104 + detailed_description: |

105 All roles will default to this variable if left unconfigured.

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

health/notifications/custom/metadata.yaml

+6 -8

@@ -36,10 +36,9 @@

36 default_value: ''

37 description: "This value is dependent on how you handle the `${to}` variable inside the `custom_sender()` function."

38 required: true

39 - detailed_description: >

40 - 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:

41 -

42 - ```conf

39 + detailed_description: |

40 + 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:

41 + ```

42 role_recipients_custom[sysadmin]="systems"

43 role_recipients_custom[domainadmin]="domains"

44 role_recipients_custom[dba]="databases systems"

@@ -51,10 +50,9 @@

50 default_value: ''

51 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."

52 required: false

54 - detailed_description: >

55 - 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:

56 -

57 - ```sh

53 + detailed_description: |

54 + 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:

55 + ```

56 custom_sender() {

57 # example human readable SMS

58 local msg="${host} ${status_message}: ${alarm} ${raised_for}"

health/notifications/discord/metadata.yaml

+2 -2

@@ -42,10 +42,10 @@

42 default_value: ''

43 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`. "

44 required: true

45 - detailed_description: >

45 + detailed_description: |

46 All roles will default to this variable if left unconfigured.

47 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:

48 - ```

48 + ```conf

49 role_recipients_discord[sysadmin]="systems"

50 role_recipients_discord[domainadmin]="domains"

51 role_recipients_discord[dba]="databases systems"

health/notifications/dynatrace/metadata.yaml

+2 -2

@@ -49,7 +49,7 @@

49 default_value: ''

50 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."

51 required: true

52 - detailed_description: >

52 + detailed_description: |

53 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.

54 - name: 'DYNATRACE_TAG_VALUE'

55 default_value: ''

@@ -63,7 +63,7 @@

63 default_value: 'Netdata Alarm'

64 description: "Set `DYNATRACE_EVENT` to the Dynatrace eventType you want."

65 required: false

66 - detailed_description: >

66 + detailed_description: |

67 `AVAILABILITY_EVENT`, `CUSTOM_ALERT`, `CUSTOM_ANNOTATION`, `CUSTOM_CONFIGURATION`, `CUSTOM_DEPLOYMENT`, `CUSTOM_INFO`, `ERROR_EVENT`,

68 `MARKED_FOR_TERMINATION`, `PERFORMANCE_EVENT`, `RESOURCE_CONTENTION_EVENT`.

69 You can read more [here](https://www.dynatrace.com/support/help/dynatrace-api/environment-api/events-v2/post-event#request-body-objects).

health/notifications/email/metadata.yaml

+2 -2

@@ -41,10 +41,10 @@

41 default_value: 'root'

42 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`."

43 required: true

44 - detailed_description: >

44 + detailed_description: |

45 All roles will default to this variable if left unconfigured.

46 The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:

47 - ```

47 + ```conf

48 role_recipients_email[sysadmin]="systems@example.com"

49 role_recipients_email[domainadmin]="domains@example.com"

50 role_recipients_email[dba]="databases@example.com systems@example.com"

health/notifications/flock/metadata.yaml

+2 -2

@@ -41,9 +41,9 @@

41 default_value: ''

42 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."

43 required: true

44 - detailed_description: >

44 + detailed_description: |

45 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:

46 - ```

46 + ```conf

47 role_recipients_flock[sysadmin]="systems"

48 role_recipients_flock[domainadmin]="domains"

49 role_recipients_flock[dba]="databases systems"

health/notifications/irc/metadata.yaml

+5 -7

@@ -33,7 +33,8 @@

33 default_value: ''

34 description: "Set the path for nc, otherwise Netdata will search for it in your system $PATH"

35 required: true

36 - detailed_description: >

36 + detailed_description: |

37 + ```sh

38 #------------------------------------------------------------------------------

39 # external commands

40 #

@@ -41,14 +42,11 @@

42 # If empty, the system $PATH will be searched for it.

43 # If not found, irc notifications will be silently disabled.

44 nc="/usr/bin/nc"

45 + ```

46 - name: 'SEND_IRC'

47 default_value: 'YES'

48 description: "Set `SEND_IRC` YES."

49 required: true

48 - - name: 'DEFAULT_RECIPIENT_IRC'

49 - default_value: ''

50 - description: "Set `DEFAULT_RECIPIENT_IRC` to one or more channels to post the messages to. You can define multiple channels like this: `#alarms` `#systems`."

51 - required: true

50 - name: 'IRC_NETWORK'

51 default_value: ''

52 description: "Set `IRC_NETWORK` to the IRC network which your preferred channels belong to."

@@ -69,9 +67,9 @@

67 default_value: ''

68 description: "You can have different channels per role, by editing `DEFAULT_RECIPIENT_IRC` with the channel you want"

69 required: true

72 - detailed_description: >

70 + detailed_description: |

71 The `DEFAULT_RECIPIENT_IRC` can be edited in the following entries at the bottom of the same file:

74 - ```

72 + ```conf

73 role_recipients_irc[sysadmin]="#systems"

74 role_recipients_irc[domainadmin]="#domains"

75 role_recipients_irc[dba]="#databases #systems"

health/notifications/kavenegar/metadata.yaml

+2 -2

@@ -46,11 +46,11 @@

46 default_value: ''

47 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."

48 required: true

49 - detailed_description: >

49 + detailed_description: |

50 All roles will default to this variable if lest unconfigured.

51

52 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:

53 - ```

53 + ```conf

54 role_recipients_kavenegar[sysadmin]="09100000000"

55 role_recipients_kavenegar[domainadmin]="09111111111"

56 role_recipients_kavenegar[dba]="0922222222"

health/notifications/matrix/metadata.yaml

+7 -7

@@ -43,7 +43,7 @@

43 default_value: ''

44 description: "Set `MATRIX_ACCESSTOKEN` to the access token from your Matrix account."

45 required: true

46 - detailed_description: >

46 + detailed_description: |

47 To obtain the access token, you can use the following curl command:

48 ```

49 curl -XPOST -d '{"type":"m.login.password", "user":"example", "password":"wordpass"}' "https://homeserver:8448/_matrix/client/r0/login"

@@ -52,16 +52,16 @@

52 default_value: ''

53 description: "Set `DEFAULT_RECIPIENT_MATRIX` to the rooms you want the alert notifications to be sent to. The format is `!roomid:homeservername`."

54 required: true

55 - detailed_description: >

55 + detailed_description: |

56 The room ids are unique identifiers and can be obtained from the room settings in a Matrix client (e.g. Riot).

57 - You can define multiple rooms like this: !roomid1:homeservername `!roomid2:homeservername`.

57 +

58 + You can define multiple rooms like this: `!roomid1:homeservername` `!roomid2:homeservername`.

59 +

60 All roles will default to this variable if left unconfigured.

61

60 - Detailed information about the Matrix client API is available at the official site.

62 + 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:

63

62 - 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:

63 -

64 - ```

64 + ```conf

65 role_recipients_matrix[sysadmin]="!roomid1:homeservername"

66 role_recipients_matrix[domainadmin]="!roomid2:homeservername"

67 role_recipients_matrix[dba]="!roomid3:homeservername"

health/notifications/messagebird/metadata.yaml

+2 -2

@@ -45,11 +45,11 @@

45 default_value: ''

46 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."

47 required: true

48 - detailed_description: >

48 + detailed_description: |

49 All roles will default to this variable if left unconfigured.

50

51 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:

52 - ```

52 + ```conf

53 role_recipients_messagebird[sysadmin]="+15555555555"

54 role_recipients_messagebird[domainadmin]="+15555555556"

55 role_recipients_messagebird[dba]="+15555555557"

health/notifications/msteams/metadata.yaml

+5 -4

@@ -44,12 +44,13 @@

44 default_value: ''

45 description: "Set `DEFAULT_RECIPIENT_MSTEAMS` to the encoded Microsoft Teams channel name you want the alert notifications to be sent to."

46 required: true

47 - detailed_description: >

48 - In Microsoft Teams the channel name is encoded in the URI after /IncomingWebhook/. You can define multiple channels like this: CHANNEL1 CHANNEL2.

47 + detailed_description: |

48 + In Microsoft Teams the channel name is encoded in the URI after `/IncomingWebhook/`. You can define multiple channels like this: `CHANNEL1` `CHANNEL2`.

49 +

50 All roles will default to this variable if left unconfigured.

51

51 - 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:

52 - ```

52 + 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:

53 + ```conf

54 role_recipients_msteams[sysadmin]="CHANNEL1"

55 role_recipients_msteams[domainadmin]="CHANNEL2"

56 role_recipients_msteams[dba]="databases CHANNEL3"

health/notifications/ntfy/metadata.yaml

+4 -4

@@ -37,15 +37,15 @@

37 required: true

38 - name: 'DEFAULT_RECIPIENT_NTFY'

39 default_value: ''

40 - 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."

40 + 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."

41 required: true

42 - detailed_description: >

43 - You can define multiple recipient URLs like this: https://SERVER1/TOPIC1 https://SERVER2/TOPIC2

42 + detailed_description: |

43 + You can define multiple recipient URLs like this: `https://SERVER1/TOPIC1` `https://SERVER2/TOPIC2`

44

45 All roles will default to this variable if left unconfigured.

46

47 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:

48 - ```

48 + ```conf

49 role_recipients_ntfy[sysadmin]="https://SERVER1/TOPIC1"

50 role_recipients_ntfy[domainadmin]="https://SERVER2/TOPIC2"

51 role_recipients_ntfy[dba]="https://SERVER3/TOPIC3"

health/notifications/pagerduty/metadata.yaml

+2 -2

@@ -40,11 +40,11 @@

40 default_value: ''

41 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`."

42 required: true

43 - detailed_description: >

43 + detailed_description: |

44 All roles will default to this variable if left unconfigured.

45

46 The `DEFAULT_RECIPIENT_PD` can be edited in the following entries at the bottom of the same file:

47 - ```

47 + ```conf

48 role_recipients_pd[sysadmin]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxa"

49 role_recipients_pd[domainadmin]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxb"

50 role_recipients_pd[dba]="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxc"

health/notifications/prowl/metadata.yaml

+2 -2

@@ -39,11 +39,11 @@

39 default_value: ''

40 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`."

41 required: true

42 - detailed_description: >

42 + detailed_description: |

43 All roles will default to this variable if left unconfigured.

44

45 The `DEFAULT_RECIPIENT_PROWL` can be edited in the following entries at the bottom of the same file:

46 - ```

46 + ```conf

47 role_recipients_prowl[sysadmin]="AAAAAAAA"

48 role_recipients_prowl[domainadmin]="BBBBBBBBB"

49 role_recipients_prowl[dba]="CCCCCCCCC"

health/notifications/pushbullet/metadata.yaml

+2 -2

@@ -41,13 +41,13 @@

41 default_value: ''

42 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."

43 required: true

44 - detailed_description: >

44 + detailed_description: |

45 You can define multiple entries like this: user1@email.com user2@email.com.

46

47 All roles will default to this variable if left unconfigured.

48

49 The `DEFAULT_RECIPIENT_PUSHBULLET` can be edited in the following entries at the bottom of the same file:

50 - ```

50 + ```conf

51 role_recipients_pushbullet[sysadmin]="user1@email.com"

52 role_recipients_pushbullet[domainadmin]="user2@mail.com"

53 role_recipients_pushbullet[dba]="#channel1"

health/notifications/pushover/metadata.yaml

+2 -2

@@ -45,11 +45,11 @@

45 default_value: ''

46 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`."

47 required: true

48 - detailed_description: >

48 + detailed_description: |

49 All roles will default to this variable if left unconfigured.

50

51 The `DEFAULT_RECIPIENT_PUSHOVER` can be edited in the following entries at the bottom of the same file:

52 - ```

52 + ```conf

53 role_recipients_pushover[sysadmin]="USERTOKEN1"

54 role_recipients_pushover[domainadmin]="USERTOKEN2"

55 role_recipients_pushover[dba]="USERTOKEN3 USERTOKEN4"

health/notifications/rocketchat/metadata.yaml

+2 -2

@@ -42,11 +42,11 @@

42 default_value: ''

43 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`."

44 required: true

45 - detailed_description: >

45 + detailed_description: |

46 All roles will default to this variable if left unconfigured.

47

48 The `DEFAULT_RECIPIENT_ROCKETCHAT` can be edited in the following entries at the bottom of the same file:

49 - ```

49 + ```conf

50 role_recipients_rocketchat[sysadmin]="systems"

51 role_recipients_rocketchat[domainadmin]="domains"

52 role_recipients_rocketchat[dba]="databases systems"

health/notifications/smstools3/metadata.yaml

+3 -3

@@ -40,7 +40,7 @@

40 default_value: 'YES'

41 description: "Set the path for `sendsms`, otherwise Netdata will search for it in your system `$PATH:`"

42 required: true

43 - detailed_description: >

43 + detailed_description: |

44 # The full path of the sendsms command (smstools3).

45 # If empty, the system $PATH will be searched for it.

46 # If not found, SMS notifications will be silently disabled.

@@ -53,11 +53,11 @@

53 default_value: ''

54 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."

55 required: true

56 - detailed_description: >

56 + detailed_description: |

57 All roles will default to this variable if left unconfigured.

58

59 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:

60 - ```

60 + ```conf

61 role_recipients_sms[sysadmin]="PHONE1"

62 role_recipients_sms[domainadmin]="PHONE2"

63 role_recipients_sms[dba]="PHONE3"

health/notifications/syslog/metadata.yaml

+3 -3

@@ -37,7 +37,7 @@

37 default_value: ''

38 description: "Set `DEFAULT_RECIPIENT_SYSLOG` to the recipient you want the alert notifications to be sent to."

39 required: true

40 - detailed_description: >

40 + detailed_description: |

41 Targets are defined as follows:

42

43 ```

@@ -56,10 +56,10 @@

56 default_value: ''

57 description: "Set SEND_SYSLOG to YES, make sure you have everything else configured before turning this on."

58 required: true

59 - detailed_description: >

59 + detailed_description: |

60 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:

61

62 - ```

62 + ```conf

63 role_recipients_syslog[sysadmin]="daemon.notice@loghost1:514/netdata"

64 role_recipients_syslog[domainadmin]="daemon.notice@loghost2:514/netdata"

65 role_recipients_syslog[dba]="daemon.notice@loghost3:514/netdata"

health/notifications/telegram/metadata.yaml

+2 -2

@@ -43,12 +43,12 @@

43 default_value: ''

44 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."

45 required: true

46 - detailed_description: >

46 + detailed_description: |

47 All roles will default to this variable if left unconfigured.

48

49 The `DEFAULT_RECIPIENT_CUSTOM` can be edited in the following entries at the bottom of the same file:

50

51 - ```

51 + ```conf

52 role_recipients_telegram[sysadmin]="49999333324"

53 role_recipients_telegram[domainadmin]="49999333389"

54 role_recipients_telegram[dba]="-1009999222255"

health/notifications/twilio/metadata.yaml

+2 -2

@@ -49,10 +49,10 @@

49 default_value: ''

50 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."

51 required: true

52 - detailed_description: >

52 + detailed_description: |

53 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:

54

55 - ```

55 + ```conf

56 role_recipients_twilio[sysadmin]="+15555555555"

57 role_recipients_twilio[domainadmin]="+15555555556"

58 role_recipients_twilio[dba]="+15555555557"

Fix formatting (#15673)