RocketChat

Send notifications to Rocket.Chat 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 RocketChat. You can use the same on all your Netdata servers (or you can have multiple if you like - your decision).
• One or more 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

Config Options

Name	Description	Default	Required
SEND_ROCKETCHAT	Set SEND_ROCKETCHAT to YES	YES	yes
ROCKETCHAT_WEBHOOK_URL	set ROCKETCHAT_WEBHOOK_URL to your webhook URL.		yes
DEFAULT_RECIPIENT_ROCKETCHAT	Set DEFAULT_RECIPIENT_ROCKETCHAT to the channel you want the alert notifications to be sent to. You can define multiple channels like this: alerts systems.		yes

DEFAULT_RECIPIENT_ROCKETCHAT

All roles will default to this variable if left unconfigured.

The DEFAULT_RECIPIENT_ROCKETCHAT can be edited in the following entries at the bottom of the same file:

role_recipients_rocketchat[sysadmin]="systems"
role_recipients_rocketchat[domainadmin]="domains"
role_recipients_rocketchat[dba]="databases systems"
role_recipients_rocketchat[webmaster]="marketing development"
role_recipients_rocketchat[proxyadmin]="proxy_admin"
role_recipients_rocketchat[sitemgr]="sites"

Examples

Basic Configuration

#------------------------------------------------------------------------------
# rocketchat (rocket.chat) global notification options

SEND_ROCKETCHAT="YES"
ROCKETCHAT_WEBHOOK_URL="<your_incoming_webhook_url>"
DEFAULT_RECIPIENT_ROCKETCHAT="monitoring_alarms"

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.