diff options
Diffstat (limited to 'health/notifications/README.md')
| -rw-r--r-- | health/notifications/README.md | 34 |
1 files changed, 18 insertions, 16 deletions
diff --git a/health/notifications/README.md b/health/notifications/README.md index 8c7ab66f..a0065729 100644 --- a/health/notifications/README.md +++ b/health/notifications/README.md @@ -7,9 +7,9 @@ You can change the default script globally by editing `/etc/netdata/netdata.conf `alarm-notify.sh` is capable of sending notifications: -- to multiple recipients -- using multiple notification methods -- filtering severity per recipient +- to multiple recipients +- using multiple notification methods +- filtering severity per recipient It uses **roles**. For example `sysadmin`, `webmaster`, `dba`, etc. @@ -23,23 +23,23 @@ Each role may have one or more destinations. So, for example the `sysadmin` role may send: -1. emails to admin1@example.com and admin2@example.com -2. pushover.net notifications to USERTOKENS `A`, `B` and `C`. -3. pushbullet.com push notifications to admin1@example.com and admin2@example.com -4. messages to slack.com channel `#alarms` and `#systems`. -5. messages to Discord channels `#alarms` and `#systems`. +1. emails to admin1@example.com and admin2@example.com +2. pushover.net notifications to USERTOKENS `A`, `B` and `C`. +3. pushbullet.com push notifications to admin1@example.com and admin2@example.com +4. messages to slack.com channel `#alarms` and `#systems`. +5. messages to Discord channels `#alarms` and `#systems`. ## Configuration Edit [`/etc/netdata/health_alarm_notify.conf`](health_alarm_notify.conf) by running `/etc/netdata/edit-config health_alarm_notify.conf`: -- settings per notification method: +- settings per notification method: - all notification methods except email, require some configuration - (i.e. API keys, tokens, destination rooms, channels, etc). + all notification methods except email, require some configuration + (i.e. API keys, tokens, destination rooms, channels, etc). -2. **recipients** per **role** per **notification method** +2. **recipients** per **role** per **notification method** ## Testing Notifications @@ -62,8 +62,10 @@ export NETDATA_ALARM_NOTIFY_DEBUG=1 Note that in versions before 1.16, the plugins.d directory may be installed in a different location in certain OSs (e.g. under `/usr/lib/netdata`). You can always find the location of the alarm-notify.sh script in `netdata.conf`. If you need to dig even deeper, you can trace the execution with `bash -x`. Note that in test mode, alarm-notify.sh calls itself with many more arguments. So first do - ```sh - bash -x /usr/libexec/netdata/plugins.d/alarm-notify.sh test - ``` + +```sh +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`. -[]() +[](<>) |