Alertbot

This bot uses the webhook functionality of monitoring/alerting solutions like Grafana or Alertmanager to forward alerts to matrix rooms. This means that you no longer have to use E-Mail or Slack to receive alerts.

You can either invite an official instance of the bot, or self-host it on your own matrix server.

Invite the Official Instance

Create a Matrix room and invite @alertbot:hyteck.de
Send !url to the room. The bot will answer with the webhook URL
Put the Webhook URL into your monitoring solution (see below)

Self-host an Instance

Prerequisites:

A Matrix server where you have access to a maubot instance
- Refer to the docs for setting up one
- or use spantaleev/matrix-docker-ansible-deploy which has built-in maubot support
An instance of alertmanager or grafana or a similar alerting program that is able to send webhooks

Build the Bot

Clone this repository and build it into a maubot plugin file (.mbp). Navigate to the Maubot Administration Interface and upload the .mpb file.

git clone https://github.com/moan0s/alertbot
cd alertbot
pip install maubot
mbc build

Configure the Bot

Next, once the plugin is installed, set up a client and then create an instance which connects the client and plugin.

Finally, invite the bot to an encrypted room where alerts should be sent and query the bot for the room id with the command !roomid.

Setup Alertmanager

This configuration will send all your alerts to the room !zOcbWjsWzdREnihgeC:example.com (if the bot has access to it). Put in your own room-id (!roomid) behind the webhook base url (!url):


receivers:
- name: alertbot
  webhook_configs:
  - url: https://synapse.hyteck.de/_matrix/maubot/plugin/alertbot/webhook/!zOcbWjsWzdREnihgeC:example.com
route:
  group_by:
  - alertname
  - cluster
  - service
  group_interval: 5m
  group_wait: 30s
  receiver: alertbot
  repeat_interval: 3h

Setup Grafana

The grafana setup is fairly simple and can be used to forward grafana alerts to matrix.

Run Locally

You might want to test the bot on your local machine but send webhooks to a public server. To do that use a domain e.g. webbhook.example.com and configure nginx as reverse proxy for port 4242 for this domain.

Connect

Run the local server and connect via (29316 is the local maubot port) ssh -N -R 4242:localhost:29316 webhook.example.com

Send Test Alerts

Use an example from the alert_examples/ to test your setup

curl --header "Content-Type: application/json" \
  --request POST \
  --data "@alert_examples/prometheus.json" \
  https://webhook.example.com/_matrix/maubot/plugin/maubot/webhook/!zOcbWjsWzdREnihreC:example.com

Matrix Room

This project has a dedicated chat room

3.2 KiB Raw Blame History