e90c3aadfb
re-worked README for initial setup |
||
---|---|---|
img | ||
host-by-telegram.sh | ||
LICENSE | ||
README.md | ||
service-by-telegram.sh |
Notification by Telegram
Send Icinga 2 notification via Telegram
Prepare
Create your bot
Obviously you need a bot to begin:
Follow the official Telegram guide and do not forget to grab your bot API TOKEN (referred to here as BOTTOKEN) afterwards
Get your chat_id(s)
You can notify a specific TG user account or throw a message to a TG group.
In order to do so you need to know the corresponding (hidden) ID also called chat_id (-q TELEGRAM_CHATID).
If you want to notify a group/channel:
-
add your bot to that group/channel
-
send with your favorite client a simple mention msg to your bot (e.g.
hi @mybot
) -
catch updates for your bot:
curl https://api.telegram.org/bot<BOTTOKEN>/getUpdates
-
review the output, an example below:
"message":{"message_id":91, "from":{"id":123456789, "is_bot":false,"first_name":"foo","username":"foobar","language_code":"de"}, "chat":{"id":-987654321, "title":"","type":"group","all_members_are_administrators":true},"date":1563547428,"group_chat_created":true}}]}`
There are 2 important parts here:
- a)
"from":{"id":123456789
which is the unique user/chat_id of the user who sends a message to your bot (required to send to a notify to that person directly) - b)
"chat":{"id":-987654321
which is the unique group/channel id of the group where the message has been sent
- a)
If you do not want to notify a group i.e. just a direct user notification:
- do the same as above, just at step 1 make a direct message to your bot instead
- as you have done a direct message you will only get a "from" id which is all you need here
Examples
Testing a notification
sending a test notification (replace the token, botname and chat id obviously)
sudo -u nagios ./service-by-telegram.sh -4 127.0.0.1 -l myhostname -o testingTGnotifiy -p <myBotname> -q <myGroupChatId> -r "<1234134325:blafasel>" -s CRITICAL -c mycomment -b mycommentuser -i https://myicingaserver/icingaweb2 -n maaaaaaaaaaa -d"$(date +%F-%T)" -e serviceshort -u fullservicename -D
Icinga2 objects
Example Notification Object
apply Notification "Host by Telegram" to Host {
command = "Notify Host By Telegram"
interval = 1h
assign where host.vars.notification_type == "Telegram"
users = [ "telegram_unixe" ]
vars.notification_logtosyslog = true
vars.telegram_bot = "<YOUR_TELEGRAM_BOT_NAME>"
vars.telegram_chatid = "<YOUR_TELEGRAM_CHAT_ID>"
vars.telegram_bottoken = "<YOUR_TELEGRAM_BOT_TOKEN>"
}
Example Command Definitions
object NotificationCommand "Notify Host By Telegram" {
import "plugin-notification-command"
command = [ "/etc/icinga2/scripts/host-by-telegram.sh" ]
arguments += {
"-4" = {
required = true
value = "$address$"
}
"-6" = "$address6$"
"-b" = "$notification.author$"
"-c" = "$notification.comment$"
"-d" = {
required = true
value = "$icinga.long_date_time$"
}
"-i" = "$icingaweb2url$"
"-l" = {
required = true
value = "$host.name$"
}
"-n" = "$host.display_name$"
"-o" = {
required = true
value = "$host.output$"
}
"-p" = {
required = true
value = "$telegram_bot$"
}
"-q" = {
required = true
value = "$telegram_botid$"
}
"-r" = {
required = true
value = "$telegram_bottoken$"
}
"-s" = {
required = true
value = "$host.state$"
}
"-t" = {
required = true
value = "$notification.type$"
}
"-v" = "$notification_logtosyslog$"
}
}
object NotificationCommand "Notify Service By Telegram" {
import "plugin-notification-command"
command = [ "/etc/icinga2/scripts/service-by-telegram.sh" ]
arguments += {
"-4" = {
required = true
value = "$address$"
}
"-6" = "$address6$"
"-b" = "$notification.author$"
"-c" = "$notification.comment$"
"-d" = {
required = true
value = "$icinga.long_date_time$"
}
"-e" = {
required = true
value = "$service.name$"
}
"-i" = "$icingaweb2url$"
"-l" = {
required = true
value = "$host.name$"
}
"-n" = "$host.display_name$"
"-o" = {
required = true
value = "$service.output$"
}
"-p" = {
required = true
value = "$telegram_bot$"
}
"-q" = {
required = true
value = "$telegram_botid$"
}
"-r" = {
required = true
value = "$telegram_bottoken$"
}
"-s" = {
required = true
value = "$service.state$"
}
"-t" = {
required = true
value = "$notification.type$"
}
"-u" = {
required = true
value = "$service.display_name$"
}
"-v" = "$notification_logtosyslog$"
}
}