Discord
Discord
Send notifications to Discord using Netdata’s Agent alert notification feature, which supports dozens of endpoints, user roles, and more.
Setup
Prerequisites
- The incoming webhook URL as given by Discord. Create a webhook by following the official Discord documentation. You can use the same on all your Netdata servers (or you can have multiple if you like - your decision).
- One or more Discord channels to post the messages to
- Access to the terminal where Netdata Agent is running
Configuration
File
The configuration file name for this integration is health_alarm_notify.conf.
You can edit the configuration file using the edit-config script from the
Netdata config directory.
cd /etc/netdata 2>/dev/null || cd /opt/netdata/etc/netdata
sudo ./edit-config health_alarm_notify.conf
Options
The following options can be defined for this notification
| Name | Description | Default | Required |
|---|---|---|---|
| SEND_DISCORD | Set SEND_DISCORD to YES |
YES | yes |
| DISCORD_WEBHOOK_URL | set DISCORD_WEBHOOK_URL to your webhook URL. |
yes | |
| DEFAULT_RECIPIENT_DISCORD | 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. |
yes |
DEFAULT_RECIPIENT_DISCORD
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:
role_recipients_discord[sysadmin]="systems"
role_recipients_discord[domainadmin]="domains"
role_recipients_discord[dba]="databases systems"
role_recipients_discord[webmaster]="marketing development"
role_recipients_discord[proxyadmin]="proxy-admin"
role_recipients_discord[sitemgr]="sites"
The values you provide should already exist as Discord channels in your server.
Examples
Basic Configuration
#------------------------------------------------------------------------------
# discord (discordapp.com) global notification options
SEND_DISCORD="YES"
DISCORD_WEBHOOK_URL="https://discord.com/api/webhooks/XXXXXXXXXXXXX/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
DEFAULT_RECIPIENT_DISCORD="alerts"
Troubleshooting
Test Notification
You can run the following command by hand, to test alerts configuration:
# become user netdata
sudo su -s /bin/bash netdata
# enable debugging info on the console
export NETDATA_ALARM_NOTIFY_DEBUG=1
# send test alarms to sysadmin
/usr/libexec/netdata/plugins.d/alarm-notify.sh test
# send test alarms to any role
/usr/libexec/netdata/plugins.d/alarm-notify.sh test "ROLE"
Note that this will test all alert mechanisms for the selected role.