matrix-alertmanager 镜像文档

镜像概述

matrix-alertmanager 是一个轻量级Docker镜像，提供Matrix机器人功能，专门用于接收Prometheus Alertmanager发送的告警信息，并将其格式化后转发至指定的Matrix聊天房间，实现监控告警的实时团队通知。

核心功能与特性

• 告警转发：接收Prometheus Alertmanager的webhook告警请求并转发至Matrix
• Matrix集成：通过Matrix API与Matrix homeserver通信，将告警发送到指定房间
• 配置灵活：支持通过环境变量配置Matrix账号、房间信息及服务参数
• 容器化部署：基于Docker打包，可快速集成到现有监控或容器化环境

使用场景与适用范围

• 监控告警通知：适用于使用Prometheus作为监控系统的团队，需将告警通过Matrix实时通知成员
• 团队协作：通过Matrix房间实现告警信息的集中展示与团队共享
• DevOps流程：集成到CI/CD或运维自动化流程中，提升告警响应效率

使用方法与配置说明

前提条件

• 一个Matrix账号（用于机器人登录，需具备访问目标房间的权限）
• 目标Matrix房间的ID（可通过Matrix客户端获取）
• Prometheus Alertmanager已部署并配置，能够发送webhook请求

环境变量配置

Docker部署示例

基本运行命令

docker run -d \
  --name matrix-alertmanager \
  -p 8080:8080 \
  -e MATRIX_HOMESERVER="[***]" \
  -e MATRIX_USER_ID="@alertbot:matrix.example.com" \
  -e MATRIX_ACCESS_TOKEN="your-matrix-access-token" \
  -e MATRIX_ROOM_ID="!target-room-id:matrix.example.com" \
  small-hack/matrix-alertmanager:latest

Docker Compose配置示例

version: '3'
services:
  matrix-alertmanager:
    image: small-hack/matrix-alertmanager:latest
    container_name: matrix-alertmanager
    ports:
      - "8080:8080"
    environment:
      - MATRIX_HOMESERVER=[***]
      - MATRIX_USER_ID=@alertbot:matrix.example.com
      - MATRIX_ACCESS_TOKEN=your-matrix-access-token
      - MATRIX_ROOM_ID=!target-room-id:matrix.example.com
      - ALERTMANAGER_WEBHOOK_PATH=/alert
      - PORT=8080
    restart: unless-stopped

Alertmanager配置

需在Alertmanager配置文件中添加webhook接收器，指向本服务：

route:
  receiver: 'matrix-notifications'
receivers:
- name: 'matrix-notifications'
  webhook_configs:
  - url: 'http://<matrix-alertmanager-ip>:8080/alert'  # 替换为服务访问地址
    send_resolved: true  # 同时发送告警恢复通知

项目地址

更多详细配置说明、更新日志及问题反馈，请访问项目GitHub页面：
[***]