Skip to content

Latest commit

 

History

History
103 lines (75 loc) · 5.04 KB

README.md

File metadata and controls

103 lines (75 loc) · 5.04 KB
Raw

Alerticular

Alerticular is the bridge between your infrastructure and your notification target. What does that mean? Well, Alerticular receives an event and sends it as a templated message somewhere else. For now it supports Prometheus Alertmanager as input and Telegram as output.

So whenever Prometheus triggers an alert you can use Alerticular to receive a Telegram message. (In the future Alerticular might support more platforms, e.g. receiving messages from kubewatch.)

Alerticular is developed with the assumption it is running in Kubernetes. There shouldn't be an issue runnig it in another way, but some examples may assume that it is used in a Kubernetes cluster with Alertmanager running in the same cluster.

Installation

Alerticular is written in Python, so in general every Python way of installing software should work.

Pip

Pip is best used inside of a virtualenv.

git clone git@github.com:ekeih/alerticular.git
cd alerticular
pip install --user poetry
poetry install
poetry shell alerticular --bot-token $TOKEN

Docker

docker run --rm --env ALERTICULAR_BOT_TOKEN="$TOKEN" ghcr.io/ekeih/alerticular:latest

Configure Telegram

  1. Talk to the BotFather via Telegram.
  2. Send /newbot and follow the instructions. For details check out the official bot documentation.
  3. Copy the bot token.
  4. Start Alerticular and pass the token
    • either as command line parameter alerticular --bot-token $TOKEN
    • or as environment variable ALERTICULAR_BOT_TOKEN="$TOKEN"
  5. Figure out the chat ID by
    • either starting a conversation with the bot by sending /start
    • or talking to the bot (or inviting it to a group/channel) and then fetching the updates manually from the Telegram API 
      curl -s https://api.telegram.org/bot$TOKEN/getUpdates | jq '.result | .[].message.chat.id'
12345678
  6. Copy the chat ID for later.

Configure Alertmanager

Please refer to the upstream documentation for a full reference of the available Alertmanager options. Alertmanager is able to call a webhook to send alerts and Alerticular is able to receive and parse those. Alerticular supports a few different URL formats to receive messages. The most verbose format is http://host:8080/from/{source}/to/{chat}/on/{target}, so to send an Alertmanager alert to a Telegram user with the chat ID 12345678 the URL would be https://alerticular.alerticular:8080/from/alertmanager/to/12345678/on/telegram (assuming Alerticular is running in Kubernetes cluster in a namespace called alerticular). In Alertmanager the configuration could look like this:

route:
  group_by: ["alertname"]
  receiver: "telegramuser1"
  routes:
    - receiver: "telegramuser2"
      match:
        alertname: EmergencyAlert
receivers:
  - name: "telegramuser1"
    webhook_configs:
      - url: "http://alerticular.alerticular:8080/from/alertmanager/to/12345678/on/telegram"
  - name: "telegramuser2"
    webhook_configs:
      - url: "http://alerticular.alerticular:8080/from/alertmanager/to/someusername/on/telegram"

If the Telegram user has a username configured it is also possible to use the username instead of the chat ID in the URL.

Templating

Alerticular ships with a default Jinja2 template for the Telegram messages. To override the template it is currently necessary to override the file (e.g. by mounting a ConfigMap in Kubernetes) but soon an easier way to pass a custom template will be provided.

To style the message you can use emoji shortcodes and the HTML style formatting options provided by telegram.

Metrics

By default Alerticular exposes Prometheus metrics at port 8081, e.g. http://localhost:8081/metrics.

Contributing

GitHub is for social coding: if you want to write code, we encourage contributions through pull requests from forks of this repository. Create GitHub tickets for bugs and new features and comment on the ones that you are interested in.

License

Alerticular - The bridge between your infrastructure and notification targets.
Copyright (C) 2020  Max Rosin

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.