Telegram
Telegram
Send notifications to Telegram using Netdata’s Agent alert notification feature, which supports dozens of endpoints, user roles, and more.
Setup
Prerequisites
- A bot token. To get one, contact the @BotFather bot and send the command
/newbotand follow the instructions. Invite your bot to a group where you want it to send messages. - The chat ID for every chat you want to send messages to. Invite @myidbot bot to the group that will receive notifications, and write the command
/getgroupid@myidbotto get the group chat ID. Group IDs start with a hyphen, supergroup IDs start with-100. - 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_TELEGRAM | Set SEND_TELEGRAM to YES |
YES | yes |
| TELEGRAM_BOT_TOKEN | set TELEGRAM_BOT_TOKEN to your bot token. |
yes | |
| DEFAULT_RECIPIENT_TELEGRAM | Set the DEFAULT_RECIPIENT_TELEGRAM variable in your config file to your Telegram chat ID (find it with @myidbot). Separate multiple chat IDs with spaces. To send alerts to a specific topic within a chat, use chatID:topicID. |
yes |
DEFAULT_RECIPIENT_TELEGRAM
All roles will default to this variable if left unconfigured.
The DEFAULT_RECIPIENT_CUSTOM can be edited in the following entries at the bottom of the same file:
role_recipients_telegram[sysadmin]="-49999333324"
role_recipients_telegram[domainadmin]="-49999333389"
role_recipients_telegram[dba]="-10099992222"
role_recipients_telegram[webmaster]="-10099992222 -49999333389"
role_recipients_telegram[proxyadmin]="-49999333344"
role_recipients_telegram[sitemgr]="-49999333876"
Examples
Basic Configuration
#------------------------------------------------------------------------------
# telegram (telegram.org) global notification options
SEND_TELEGRAM="YES"
TELEGRAM_BOT_TOKEN="111122223:7OpFlFFRzRBbrUUmIjj5HF9Ox2pYJZy5"
DEFAULT_RECIPIENT_TELEGRAM="-49999333876"
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.