diff options
Diffstat (limited to '')
26 files changed, 52 insertions, 46 deletions
diff --git a/health/notifications/README.md b/health/notifications/README.md index 53541981..0bd6c764 100644 --- a/health/notifications/README.md +++ b/health/notifications/README.md @@ -83,4 +83,4 @@ bash -x /usr/libexec/netdata/plugins.d/alarm-notify.sh test ``` Then look in the output for the alarm-notify.sh calls and run the one you want to trace with `bash -x`. -[](<>) + diff --git a/health/notifications/alerta/README.md b/health/notifications/alerta/README.md index 85a0cd48..9603aae0 100644 --- a/health/notifications/alerta/README.md +++ b/health/notifications/alerta/README.md @@ -78,4 +78,4 @@ We can test alarms using the standard approach: For more information see the [Alerta documentation](https://docs.alerta.io) -[](<>) + diff --git a/health/notifications/awssns/README.md b/health/notifications/awssns/README.md index c6825137..fc4a665e 100644 --- a/health/notifications/awssns/README.md +++ b/health/notifications/awssns/README.md @@ -6,7 +6,8 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notificat # Amazon SNS -As part of it's AWS suite, Amazon provides a notification broker service called 'Simple Notification Service' or SNS. Amazon SNS works kind of similarly to Netdata's own notification system, allowing dispatch of a single notification to multiple subscribers of different types. Among other things, SNS supports sending notifications to: +As part of its AWS suite, Amazon provides a notification broker service called 'Simple Notification Service' (SNS). Amazon SNS works similarly to Netdata's own notification system, allowing to dispatch a single notification to multiple subscribers of different types. While Amazon SNS supports sending differently formatted messages for different delivery methods, Netdata does not currently support this functionality. +Among other things, SNS supports sending notifications to: - Email addresses. - Mobile Phones via SMS. @@ -15,29 +16,38 @@ As part of it's AWS suite, Amazon provides a notification broker service called - AWS SQS queues. - Mobile applications via push notifications. -To get this working, you will need: +For email notification support, we recommend using Netdata's email notifications, as it is has the following benefits: -- The Amazon Web Services CLI tools. Most distributions provide these with the package name `awscli`. -- An actual home directory for the user you run Netdata as, instead of just using `/` as a home directory. Setup of this is distribution specific. `/var/lib/netdata` is the recommended directory (because the permissions will already be correct) if you are using a dedicated user (which is how most distributions work). -- An Amazon SNS topic to send notifications to with one or more subscribers. The [Getting - Started](https://docs.aws.amazon.com/sns/latest/dg/sns-getting-started.html) section of the Amazon SNS documentation - covers the basics of how to set this up. Make note of the Topic ARN when you create the topic. -- While not mandatory, it is highly recommended to create a dedicated IAM user on your account for Netdata to send notifications. This user needs to have programmatic access, and should only allow access to SNS. If you're really paranoid, you can create one for each system or group of systems. +- In most cases, it requires less configuration. +- Netdata's emails are nicely pre-formatted and support features like threading, which requires a lot of manual effort in SNS. +- It is less resource intensive and more cost-efficient than SNS. -Once you have all the above, run the following command as the user Netdata runs under: +Read on to learn how to set up Amazon SNS in Netdata. -``` -aws configure -``` +## Prerequisites -THis will prompt you for the access key and secret key for accessing Amazon SNS (as well as the default region and output format, but you can leave those blank because we don't use them). +Before you can enable SNS, you need: -Once that's done, you're ready to go and can specify the desired topic ARN as a recipient. +- The [Amazon Web Services CLI tools](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) (`awscli`). +- An actual home directory for the user you run Netdata as, instead of just using `/` as a home directory. The setup depends on the distribution, but `/var/lib/netdata` is the recommended directory. If you are using Netdata as a dedicated user, the permissions will already be correct. +- An Amazon SNS topic to send notifications to with one or more subscribers. The [Getting Started](https://docs.aws.amazon.com/sns/latest/dg/sns-getting-started.html) section of the Amazon SNS documentation covers the basics of how to set this up. Make note of the **Topic ARN** when you create the topic. +- While not mandatory, it is highly recommended to create a dedicated IAM user on your account for Netdata to send notifications. This user needs to have programmatic access, and should only allow access to SNS. For an additional layer of security, you can create one for each system or group of systems. -Notes: +## Enabling Amazon SNS -- Netdata's native email notification support is far better in almost all respects than it's support through Amazon SNS. If you want email notifications, use the native support, not SNS. - - If you need to change the notification format for SNS notifications, you can do so by specifying the format in `AWSSNS_MESSAGE_FORMAT` in the configuration. This variable supports all the same variables you can use in custom notifications. - - While Amazon SNS supports sending differently formatted messages for different delivery methods, Netdata does not currently support this functionality. +To enable SNS: +1. Run the following command as the user Netdata runs under: + ``` + aws configure + ``` +2. Enter the access key and secret key for accessing Amazon SNS. The system also prompts you to enter the default region and output format, but you can leave those blank because Netdata doesn't use them. -[](<>) +3. Specify the desired topic ARN as a recipient, see [SNS documentation](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/US_SetupSNS.html#set-up-sns-topic-cli). +4. Optional: To change the notification format for SNS notifications, change the `AWSSNS_MESSAGE_FORMAT` variable in `health_alarm_notify.conf`. +This variable supports all the same variables you can use in custom notifications. + + The default format looks like this: + ```bash + AWSSNS_MESSAGE_FORMAT="${status} on ${host} at ${date}: ${chart} ${value_string}" + ``` + diff --git a/health/notifications/custom/README.md b/health/notifications/custom/README.md index bcb09ef5..edc42623 100644 --- a/health/notifications/custom/README.md +++ b/health/notifications/custom/README.md @@ -89,4 +89,4 @@ The following are more human friendly: - `${severity}` like "Escalated to CRITICAL", "Recovered from WARNING" - `${raised_for}` like "(alarm was raised for 10 minutes)" -[](<>) + diff --git a/health/notifications/discord/README.md b/health/notifications/discord/README.md index 1650d9ce..568d03bc 100644 --- a/health/notifications/discord/README.md +++ b/health/notifications/discord/README.md @@ -47,4 +47,4 @@ role_recipients_discord[webmaster]="marketing development" The keywords `systems`, `databases`, `marketing`, `development` are discordapp.com channels (they should already exist within your discord server). -[](<>) + diff --git a/health/notifications/dynatrace/README.md b/health/notifications/dynatrace/README.md index cc82ee78..3f8ad85b 100644 --- a/health/notifications/dynatrace/README.md +++ b/health/notifications/dynatrace/README.md @@ -32,5 +32,3 @@ The default value is `CUSTOM_INFO`. This is a required parameter. 6. Specify the annotation type. This is the source of the Dynatrace event. Put whatever it fits you, for example, _Netdata Alarm_, which is also the default value. - -[]() diff --git a/health/notifications/email/README.md b/health/notifications/email/README.md index 82786fca..3dc84dd4 100644 --- a/health/notifications/email/README.md +++ b/health/notifications/email/README.md @@ -74,4 +74,4 @@ sendmail="/usr/bin/msmtp" chmod 600 ~/.msmtprc ``` -[](<>) + diff --git a/health/notifications/flock/README.md b/health/notifications/flock/README.md index b24ecdb2..b9e0025b 100644 --- a/health/notifications/flock/README.md +++ b/health/notifications/flock/README.md @@ -34,4 +34,4 @@ FLOCK_WEBHOOK_URL="https://api.flock.com/hooks/sendMessage/XXXXXXXXXXXXXXXXXXXXX DEFAULT_RECIPIENT_FLOCK="alarms" ``` -[](<>) + diff --git a/health/notifications/hangouts/README.md b/health/notifications/hangouts/README.md index 886abfc4..7554b39c 100644 --- a/health/notifications/hangouts/README.md +++ b/health/notifications/hangouts/README.md @@ -52,4 +52,4 @@ You can define multiple rooms like this: `sysadmin devops alarms|critical`. The keywords `sysadmin`, `devops`, and `alarms` are Hangouts rooms. -[](<>) + diff --git a/health/notifications/irc/README.md b/health/notifications/irc/README.md index e7f22e1f..21c998d1 100644 --- a/health/notifications/irc/README.md +++ b/health/notifications/irc/README.md @@ -75,4 +75,4 @@ role_recipients_irc[webmaster]="#networking-alarms" The keywords `#user-alarms`, `#networking-alarms`, `#system-alarms`, `#databases-alarms` are irc channels which belong to the specified IRC network. -[](<>) + diff --git a/health/notifications/kavenegar/README.md b/health/notifications/kavenegar/README.md index b59799fc..6123eb90 100644 --- a/health/notifications/kavenegar/README.md +++ b/health/notifications/kavenegar/README.md @@ -43,4 +43,4 @@ KAVENEGAR_SENDER="" DEFAULT_RECIPIENT_KAVENEGAR="" ``` -[](<>) + diff --git a/health/notifications/matrix/README.md b/health/notifications/matrix/README.md index ea22b4a8..8eeecf55 100644 --- a/health/notifications/matrix/README.md +++ b/health/notifications/matrix/README.md @@ -55,4 +55,4 @@ MATRIX_ACCESSTOKEN="XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX" DEFAULT_RECIPIENT_MATRIX="!XXXXXXXXXXXX:matrix.org" ``` -[](<>) + diff --git a/health/notifications/messagebird/README.md b/health/notifications/messagebird/README.md index 8e3d1a5b..f70e86c6 100644 --- a/health/notifications/messagebird/README.md +++ b/health/notifications/messagebird/README.md @@ -42,4 +42,4 @@ MESSAGEBIRD_NUMBER="XXXXXXX" DEFAULT_RECIPIENT_MESSAGEBIRD="XXXXXXX" ``` -[](<>) + diff --git a/health/notifications/msteams/README.md b/health/notifications/msteams/README.md index 3ff5de68..14dbe751 100644 --- a/health/notifications/msteams/README.md +++ b/health/notifications/msteams/README.md @@ -42,4 +42,4 @@ role_recipients_msteams[dba]="YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY" role_recipients_msteams[webmaster]="ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ" ``` -[](<>) + diff --git a/health/notifications/opsgenie/README.md b/health/notifications/opsgenie/README.md index 10b9f524..640fcd42 100644 --- a/health/notifications/opsgenie/README.md +++ b/health/notifications/opsgenie/README.md @@ -59,4 +59,4 @@ message: You can find more details about the Opsgenie error codes in their [response docs](https://docs.opsgenie.com/docs/response). -[](<>) + diff --git a/health/notifications/prowl/README.md b/health/notifications/prowl/README.md index 7c60de27..dc136820 100644 --- a/health/notifications/prowl/README.md +++ b/health/notifications/prowl/README.md @@ -25,5 +25,3 @@ the Prowl website after registering. Once you have an API key, simply specify that as a recipient for Prowl notifications. - -[]() diff --git a/health/notifications/pushbullet/README.md b/health/notifications/pushbullet/README.md index 7c2f6774..194050bc 100644 --- a/health/notifications/pushbullet/README.md +++ b/health/notifications/pushbullet/README.md @@ -47,4 +47,4 @@ PUSHBULLET_ACCESS_TOKEN="o.Sometokenhere" DEFAULT_RECIPIENT_PUSHBULLET="admin1@example.com admin3@somemail.com #examplechanneltag #anotherchanneltag" ``` -[](<>) + diff --git a/health/notifications/pushover/README.md b/health/notifications/pushover/README.md index 3ba97fbc..1e50f714 100644 --- a/health/notifications/pushover/README.md +++ b/health/notifications/pushover/README.md @@ -20,4 +20,4 @@ pushover.net notifications look like this:  -[](<>) + diff --git a/health/notifications/rocketchat/README.md b/health/notifications/rocketchat/README.md index a54f5826..96d6160b 100644 --- a/health/notifications/rocketchat/README.md +++ b/health/notifications/rocketchat/README.md @@ -49,4 +49,4 @@ role_recipients_rocketchat[webmaster]="marketing development" The keywords `systems`, `databases`, `marketing`, `development` are RocketChat channels (they should already exist). Both public and private channels can be used, even if they differ from the channel configured in your RocketChat incoming webhook. -[](<>) + diff --git a/health/notifications/slack/README.md b/health/notifications/slack/README.md index e338e9af..ad36ce34 100644 --- a/health/notifications/slack/README.md +++ b/health/notifications/slack/README.md @@ -47,4 +47,4 @@ role_recipients_slack[dba]="databases systems" role_recipients_slack[webmaster]="marketing development" ``` -[](<>) + diff --git a/health/notifications/smstools3/README.md b/health/notifications/smstools3/README.md index 6d90e702..6618dfa1 100644 --- a/health/notifications/smstools3/README.md +++ b/health/notifications/smstools3/README.md @@ -41,4 +41,4 @@ Netdata uses the script `sendsms` that is installed by `smstools3` and just pass sendsms="" ``` -[](<>) + diff --git a/health/notifications/stackpulse/README.md b/health/notifications/stackpulse/README.md index 4c44954a..c478fd58 100644 --- a/health/notifications/stackpulse/README.md +++ b/health/notifications/stackpulse/README.md @@ -78,4 +78,4 @@ access the **TRIGGER** tab to define the scenarios used to trigger the event. Th For more details how to create a scenario, take a look at the [StackPulse documentation](https://docs.stackpulse.io). -[](<>) + diff --git a/health/notifications/syslog/README.md b/health/notifications/syslog/README.md index 360f6844..8b7863a1 100644 --- a/health/notifications/syslog/README.md +++ b/health/notifications/syslog/README.md @@ -31,4 +31,4 @@ The `facility` and `level` are the standard syslog facility and level options, f You can configure sending directly to remote log servers by specifying a host (and optionally a port). However, this has a somewhat high overhead, so it is much preferred to use your local syslog daemon to handle the forwarding of messages to remote systems (pretty much all of them allow at least simple forwarding, and most of the really popular ones support complex queueing and routing of messages to remote log servers). -[](<>) + diff --git a/health/notifications/telegram/README.md b/health/notifications/telegram/README.md index c1c6f2a4..2a2ed562 100644 --- a/health/notifications/telegram/README.md +++ b/health/notifications/telegram/README.md @@ -42,4 +42,4 @@ Telegram messages look like this:  -[](<>) + diff --git a/health/notifications/twilio/README.md b/health/notifications/twilio/README.md index b36d40b9..b563c66c 100644 --- a/health/notifications/twilio/README.md +++ b/health/notifications/twilio/README.md @@ -44,4 +44,4 @@ TWILIO_NUMBER="xxxxxxxxxxx" DEFAULT_RECIPIENT_TWILIO="+15555555555" ``` -[](<>) + diff --git a/health/notifications/web/README.md b/health/notifications/web/README.md index 9e491860..185843af 100644 --- a/health/notifications/web/README.md +++ b/health/notifications/web/README.md @@ -10,4 +10,4 @@ The Netdata dashboard shows HTML notifications, when it is open. Such web notifications look like this:  -[](<>) + |