matrix-docker-ansible-deploy/docs/configuring-playbook-alertmanager-receiver.md

Setting up matrix-alertmanager-receiver (optional)

The playbook can install and configure the matrix-alertmanager-receiver service for you. It's a client for Prometheus' Alertmanager, allowing you to deliver alerts to Matrix rooms.

See the project's documentation to learn more about what this component does and why it might be useful to you.

At the moment, setting up this service's bot requires some manual actions as described below in Account and room preparation.

This service is meant to be used with an external Alertmanager instance. It's not meant to be integrated with the Prometheus & Grafana stack installed by this playbook, because the Alertmanager component is not installed by it.

Configuration

matrix_alertmanager_receiver_enabled: true

# This exposes matrix-alertmanager-receiver on the `matrix.` domain.
# Adjust, if necessary.
matrix_alertmanager_receiver_hostname: "{{ matrix_server_fqn_matrix }}"

# This exposes matrix-alertmanager-receiver under a path prefix containing a random (secret) value.
# Adjust the `RANDOM_VALUE_HERE` part with a long and secure value.
matrix_alertmanager_receiver_path_prefix: /matrix-alertmanager-receiver-RANDOM_VALUE_HERE

# If you'd like to change the username for this bot, uncomment and adjust. Otherwise, remove.
# matrix_alertmanager_receiver_config_matrix_user_id_localpart: "bot.alertmanager.receiver"

# Specify the bot user's access token here.
# See the "Account and room preparation" section below.
matrix_alertmanager_receiver_config_matrix_access_token: ''

# Optionally, configure some mappings (URL-friendly room name -> actual Matrix room ID).
#
# If you don't configure mappings, you can still deliver alerts using URLs like this:
# https://matrix.DOMAIN/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/!some-room-id:example.com
#
# If a mapping like the one below is configured, you can deliver alerts using friendlier URLs like this:
# https://matrix.DOMAIN/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/some-room-name
matrix_alertmanager_receiver_config_matrix_room_mapping:
  some-room-name: "!some-room-id:{{ matrix_domain }}"

See roles/custom/matrix-alertmanager-receiver/defaults/main.yml for additional configuration variables.

Account and room preparation

The playbook can automatically create users, but it cannot automatically obtain access tokens, nor perform any of the other manual actions below.

matrix-alertmanager-receiver uses a bot (with a username specified in matrix_alertmanager_receiver_config_matrix_user_id_localpart - see above) for delivering messages. You need to manually register this bot acccount and obtain an access token for it.

1. Register a new user: ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=bot.alertmanager.receiver password=PASSWORD_FOR_THE_BOT admin=no' --tags=register-user
2. Obtain an access token for the bot's user account
3. Invite the bot to a room where you'd like to alerts to be delivered
4. Log in as the bot using any Matrix client of your choosing, accept the room invitation from the bot's account and log out
5. (Optionally) Adjust matrix_alertmanager_receiver_config_matrix_room_mapping to create a mapping between the new room and its id

Steps 1 and 2 above only need to be done once, while preparing your configuration.

Steps 3 and 4 need to be done for each new room you'd like the bot to deliver alerts to. Step 5 is optional and provides cleaner /alert/ URLs.

Installation

Now that you've prepared the bot account and room and have configured the playbook, you can re-run the installation process (just install-all).

Then, you can proceed to Usage.

Usage

Configure your Prometheus Alertmanager with configuration like this:

  receivers:
    - name: matrix
      webhook_configs:
        - send_resolved: true
          url: URL_HERE
  route:
    group_by:
      - namespace
    group_interval: 5m
    group_wait: 30s
    receiver: "matrix"
    repeat_interval: 12h
    routes:
      - receiver: matrix

.. where URL_HERE looks like https://matrix.DOMAIN/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/some-room-name or https://matrix.DOMAIN/matrix-alertmanager-receiver-RANDOM_VALUE_HERE/alert/!some-room-id:DOMAIN.

This bot does not accept room invitations automatically (like many other bots do). To deliver messages to rooms, the bot must be joined to all rooms manually - see Step 5 of the Account and room preparation section.