Twilio
Twilio
Send notifications to Twilio using Netdata’s Agent alert notification feature, which supports dozens of endpoints, user roles, and more.
Setup
Prerequisites
- Get your SID, and Token from https://www.twilio.com/console
- Terminal access to the Agent you wish to configure
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_TWILIO | Set SEND_TWILIO to YES |
YES | yes |
| TWILIO_ACCOUNT_SID | set TWILIO_ACCOUNT_SID to your account SID. |
yes | |
| TWILIO_ACCOUNT_TOKEN | Set TWILIO_ACCOUNT_TOKEN to your account token. |
yes | |
| TWILIO_NUMBER | Set TWILIO_NUMBER to your account’s number. |
yes | |
| DEFAULT_RECIPIENT_TWILIO | 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. | yes |
DEFAULT_RECIPIENT_TWILIO
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:
role_recipients_twilio[sysadmin]="+15555555555"
role_recipients_twilio[domainadmin]="+15555555556"
role_recipients_twilio[dba]="+15555555557"
role_recipients_twilio[webmaster]="+15555555558"
role_recipients_twilio[proxyadmin]="+15555555559"
role_recipients_twilio[sitemgr]="+15555555550"
Examples
Basic Configuration
#------------------------------------------------------------------------------
# Twilio (twilio.com) SMS options
SEND_TWILIO="YES"
TWILIO_ACCOUNT_SID="xxxxxxxxx"
TWILIO_ACCOUNT_TOKEN="xxxxxxxxxx"
TWILIO_NUMBER="xxxxxxxxxxx"
DEFAULT_RECIPIENT_TWILIO="+15555555555"
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.