From 836b47cb7e99a977c5a23b059ca1d0b5065d310e Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 24 Jul 2024 11:54:23 +0200 Subject: Merging upstream version 1.46.3. Signed-off-by: Daniel Baumann --- health/notifications/telegram/README.md | 118 -------------------------------- 1 file changed, 118 deletions(-) delete mode 100644 health/notifications/telegram/README.md (limited to 'health/notifications/telegram/README.md') diff --git a/health/notifications/telegram/README.md b/health/notifications/telegram/README.md deleted file mode 100644 index 315bd9b1..00000000 --- a/health/notifications/telegram/README.md +++ /dev/null @@ -1,118 +0,0 @@ - - -# 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](https://t.me/BotFather) bot and send the command `/newbot` and follow the instructions. Start a conversation with your bot or invite it into a group where you want it to send messages. -- The chat ID for every chat you want to send messages to. Contact the [@myidbot](https://t.me/myidbot) bot and send the `/getid` command to get your personal chat ID or invite it into a group and use the `/getgroupid` command to get the group chat ID. Group IDs start with a hyphen, supergroup IDs start with `-100`. -- Alternatively, you can get the chat ID directly from the bot API. Send your bot a command in the chat you want to use, then check `https://api.telegram.org/bot{YourBotToken}/getUpdates`, eg. `https://api.telegram.org/bot111122223:7OpFlFFRzRBbrUUmIjj5HF9Ox2pYJZy5/getUpdates` -- 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](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md#the-netdata-config-directory). - -```bash -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_TELEGRAM | Set `SEND_TELEGRAM` to YES | YES | yes | -| TELEGRAM_BOT_TOKEN | set `TELEGRAM_BOT_TOKEN` to your bot token. | | yes | -| DEFAULT_RECIPIENT_TELEGRAM | Set `DEFAULT_RECIPIENT_TELEGRAM` to the chat ID you want the alert notifications to be sent to. You can define multiple chat IDs like this: 49999333322 -1009999222255. | | 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: - -```conf -role_recipients_telegram[sysadmin]="49999333324" -role_recipients_telegram[domainadmin]="49999333389" -role_recipients_telegram[dba]="-1009999222255" -role_recipients_telegram[webmaster]="-1009999222255 49999333389" -role_recipients_telegram[proxyadmin]="49999333344" -role_recipients_telegram[sitemgr]="49999333876" -``` - - -
- -#### Examples - -##### Basic Configuration - - - -```yaml -#------------------------------------------------------------------------------ -# telegram (telegram.org) global notification options - -SEND_TELEGRAM="YES" -TELEGRAM_BOT_TOKEN="111122223:7OpFlFFRzRBbrUUmIjj5HF9Ox2pYJZy5" -DEFAULT_RECIPIENT_TELEGRAM="-100233335555" - -``` - - -## Troubleshooting - -### Test Notification - -You can run the following command by hand, to test alerts configuration: - -```bash -# 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. - - -- cgit v1.2.3