73 lines
1.8 KiB
Markdown
73 lines
1.8 KiB
Markdown
# notify-by-telegram
|
|
Send Nagios notifications to a [Telegram Messenger](https://telegram.org/) channel.
|
|
|
|
|
|
## Telegram bot
|
|
|
|
This [tutorial](https://takersplace.de/2019/12/19/telegram-notifications-with-nagios/) explains how to create a Telegram bot. You'll need the `chat_id` and `auth_key` for the next section.
|
|
|
|
## Installation
|
|
|
|
_This guide has been written for [Debian](https://www.debian.org/). Some commands might slightly change depending on your distribution._
|
|
|
|
Clone the repository:
|
|
```
|
|
git clone https://github.com/jouir/notify-by-telegram.git /opt/notify-by-telegram
|
|
```
|
|
|
|
Install dependencies using the package manager:
|
|
```
|
|
sudo apt install python3-jinja2 python3-requests
|
|
```
|
|
|
|
## Configuration
|
|
|
|
Copy and update the configuration file example:
|
|
```
|
|
cp -p config.json.example telegram.json
|
|
vim telegram.json
|
|
sudo mv telegram.json /etc/nagios4/telegram.json
|
|
sudo chown root:nagios /etc/nagios4/telegram.json
|
|
sudo chmod 640 /etc/nagios4/telegram.json
|
|
```
|
|
|
|
Ensure Nagios reads the configuration file:
|
|
```
|
|
echo "cfg_file=/opt/notify-by-telegram/nagios.cfg" >> /etc/nagios4/nagios.cfg
|
|
```
|
|
|
|
Then reload service:
|
|
```
|
|
systemctl reload nagios4
|
|
```
|
|
|
|
## Logs
|
|
|
|
Errors logs can be set with the `--logfile` argument.
|
|
|
|
Example:
|
|
```
|
|
tail -f /var/log/nagios4/telegram.log
|
|
```
|
|
|
|
Log level can be raised using `--verbose` or even more with `--debug` arguments.
|
|
|
|
|
|
## Message format
|
|
|
|
`notify-by-telegram` script uses the `MarkdownV2` format to generate Telegram messages.
|
|
|
|
[Jinja](https://jinja.palletsprojects.com) is used for templating (eg. replace `{{host_name}}` placeholders by the value submitted by Nagios).
|
|
|
|
Default **host** and **service** templates can be found in the [templates](templates) directory.
|
|
|
|
They can be overriden in the configuration file:
|
|
|
|
```json
|
|
{
|
|
"host_template": "/etc/nagios4/host.md.j2",
|
|
"service_template": "/etc/nagios4/service.md.j2"
|
|
}
|
|
```
|
|
|
|
Both options are optional.
|