Netdata SMS & voice alerts & notifications – integration manual
Here we describe how to setup Netdata with SMSEagle for SMS and voice call alerts. The configuration is fast & easy – it should take you about 5-10 min to have it up and running.
SMSEagle is an offline hardware SMS gateway. Therefore no external connection to 3rd party system is required. All notifications are generated on-premise and sent directly to a cellular network. This solution can be used in secure installations without Internet access.
The configuration process is also described in Netdata Documentation portal.
SMSEagle Setup
Before using the API, you’ll need to enable API access on your SMSEagle device by following these steps:
- Navigate to the Web-GUI and select the Users menu.
- Create a new user in SMSEagle + Add Users, user access level: “User”.
- Locate the Access to API option next to your newly created user.
- Select APIv2 and click the Generate new token button to create your API access token.
- Set up the appropriate permissions in the APIv2 Permission section:
- Add access permissions in section Messages for: Send SMS.
- Add access permissions in section Calls for: Make a ring call, Make a TTS call, Make a TTS Advanced call (if you setup voice/calls alerting).
Netdata Setup
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 |
|---|---|---|---|
| DEFAULT_RECIPIENT_SMSEAGLE | If a role’s recipients are not configured, a notification will be sent to this SMS recipient (empty = do not send a notification for unconfigured roles). Multiple recipients can be given like this: “PHONE1,PHONE2…” | yes | |
| SMSEAGLE_API_URL | yes | ||
| SMSEAGLE_API_ACCESSTOKEN | yes | ||
| SMSEAGLE_MSG_TYPE | sms | yes | |
| SMSEAGLE_CALL_DURATION | 10 | yes | |
| SMSEAGLE_VOICE_ID | 10 | yes |
DEFAULT_RECIPIENT_SMSEAGLE
All roles will default to this variable if left unconfigured.
You can then have different recipients per role, by editing DEFAULT_RECIPIENT_SMSEAGLE with the number you want, in the following entries at the bottom of the same file:
role_recipients_smseagle[sysadmin]="+11222333444"
role_recipients_smseagle[domainadmin]="+11222333445"
role_recipients_smseagle[dba]="+11222333446"
role_recipients_smseagle[webmaster]="+11222333447"
role_recipients_smseagle[proxyadmin]="+11222333448"
role_recipients_smseagle[sitemgr]="+11222333449"
SMSEAGLE_API_URL
The url of the SMSEagle device accessible from NetData, e.g https://192.168.0.101
SMSEAGLE_API_ACCESSTOKEN
An access token for the user created at SMSEagle device
SMSEAGLE_MSG_TYPE
Choose a type of message/call. Available types: sms, mms, ring (wake-up call), tts (text-to-speech call), tts_advanced (multilanguage text-to-speech call). Be aware that some types require additional parameters to be set.
SMSEAGLE_CALL_DURATION
Call duration, parameter required for Ring, TTS and TTS Advanced.
SMSEAGLE_VOICE_ID
ID of the voice model, required for TTS Advanced.
Examples
Configuration for SMS
#------------------------------------------------------------------------------
# SMSEagle options
SEND_SMSEAGLE="YES"
SMSEAGLE_API_URL="XXXXXXXX"
SMSEAGLE_API_ACCESSTOKEN="XXXXXXX"
SMSEAGLE_MSG_TYPE="sms"
DEFAULT_RECIPIENT_SMSEAGLE="+11222333444"
Configuration for Wake-up Call alert (ring only call)
#------------------------------------------------------------------------------
# SMSEagle options
SEND_SMSEAGLE="YES"
SMSEAGLE_API_URL="XXXXXXXX"
SMSEAGLE_API_ACCESSTOKEN="XXXXXXX"
SMSEAGLE_MSG_TYPE="ring"
SMSEAGLE_CALL_DURATION="15"
DEFAULT_RECIPIENT_SMSEAGLE="+11222333444"
Configuration for Voice Call alert (text-to-speech call)
#------------------------------------------------------------------------------
# SMSEagle options
SEND_SMSEAGLE="YES"
SMSEAGLE_API_URL="XXXXXXXX"
SMSEAGLE_API_ACCESSTOKEN="XXXXXXX"
SMSEAGLE_MSG_TYPE="tts_advanced"
SMSEAGLE_CALL_DURATION="15"
SMSEAGLE_VOICE_ID="1"
DEFAULT_RECIPIENT_SMSEAGLE="+11222333444"
Troubleshooting
Test Notification
# 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.
Notice: Wake-up Calls and Text-to-Speech Calls are only available to users who have purchased the VOICE add-on for their SMSEagle device.
Explore SMSEagle Demo device
SMSEagle is a hardware & software solution that guarantees a swift delivery of your messages to designated recipients, whether it’s for notifications, alerts, or important updates.
After registering to a demo you get a remote access to our physical device NXS-9750.
- 14-days free trial
- Access to over 20 functionalities
