idealista/prom2teams

prom2teams：Prometheus Alertmanager与Microsoft Teams集成工具

prom2teams是一个基于Python构建的服务，用于接收来自Prometheus Alertmanager的告警通知，并通过已定义的连接器转发至Microsoft Teams。其核心特性包括告警分组、标签/注解排除及Teams告警重试策略等。

镜像概述和主要用途

prom2teams作为Prometheus与Microsoft Teams之间的桥梁，解决了Prometheus告警无法直接发送至Microsoft Teams的问题。通过配置连接器和自定义模板，用户可以将Prometheus监控系统产生的告警信息格式化后发送到指定的Teams频道，实现高效的告警通知与协作。

核心功能和特性

• 告警分组：支持按"name"、"description"、"instance"、"severity"或"summary"字段对告警进行分组
• 标签/注解排除：可配置排除特定标签或注解，精简告警信息
• Teams告警重试策略：支持启用重试机制，配置重试间隔时间
• 自定义模板：通过Jinja2模板自定义Teams消息格式
• Prometheus指标支持：启用后可通过/metrics端点暴露服务运行指标
• 多连接器支持：配置文件中可定义多个Microsoft Teams连接器

使用场景和适用范围

适用于所有使用Prometheus作为监控系统，并需要将告警通知集成到Microsoft Teams的团队，尤其适合：

• DevOps团队实时接收系统异常告警
• SRE团队集中管理多环境监控告警
• 开发团队及时获取应用性能或错误告警
• 需要自定义告警格式和通知策略的企业级监控场景

使用方法和配置说明

Docker镜像使用

基本运行命令

bash
# 使用环境变量指定连接器和分组字段
docker run -it -d \
  -e PROM2TEAMS_GROUP_ALERTS_BY=severity \
  -e PROM2TEAMS_CONNECTOR="https://outlook.office.com/webhook/..." \
  -p 8089:8089 \
  idealista/prom2teams:VERSION

挂载自定义配置文件

bash
# 使用本地配置文件覆盖容器默认配置
docker run -it -d \
  -v /path/to/local/config.ini:/opt/prom2teams/config.ini \
  -p 8089:8089 \
  idealista/prom2teams:VERSION

配置文件说明

配置文件为INI格式，结构如下：

ini
[Microsoft Teams]
# 至少需要一个连接器
Connector: <webhook url>
AnotherConnector: <webhook url>

[HTTP Server]
Host: <主机IP>  # 默认: localhost
Port: <端口>    # 默认: 8089

[Log]
Level: <日志级别(DEBUG|INFO|WARNING|ERROR|CRITICAL)>  # 默认: DEBUG
Path: <日志文件路径>  # 默认: /var/log/prom2teams/prom2teams.log

[Template]
Path: <Jinja2模板路径>  # 默认: 内置模板

[Group Alerts]
Field: <分组字段>  # 可选，不配置则不分组

[Labels]
Excluded: <逗号分隔的要排除的标签>

[Annotations]
Excluded: <逗号分隔的要排除的注解>

[Teams Client]
RetryEnable: <是否启用重试>  # 默认: false
RetryWaitTime: <重试间隔(秒)>  # 默认: 60
MaxPayload: <最大 payload 限制(字节)>  # 默认: 24576 (24KB)

Prometheus配置

在Prometheus Alertmanager配置中添加webhook接收器：

yaml
receivers:
- name: 'teams-notifications'
  webhook_configs:
  - url: 'http://prom2teams:8089/v2/Connector'  # Connector为配置文件中的连接器名称
    send_resolved: true

模板定制

可通过--templatepath参数指定自定义Jinja2模板：

bash
prom2teams --templatepath /path/to/custom_template.j2

默认模板提供了基本的告警信息展示，包含告警状态、标签、注解等内容。自定义模板可根据需求调整消息格式和内容。

生产环境部署

推荐使用uWSGI作为WSGI服务器运行：

bash
# 安装时需添加--no-binary选项
pip install --no-binary :all: prom2teams

# 使用uWSGI配置文件启动
prom2teams_uwsgi /path/to/uwsgi.ini

uWSGI配置示例：

ini
[uwsgi]
master = true
processes = 5
socket = /tmp/prom2teams.sock
chmod-socket = 777
vacuum = true
env = APP_ENVIRONMENT=pro
env = APP_CONFIG_FILE=/etc/default/prom2teams.ini

文档与监控

Swagger UI

• API v1文档：访问http://<host>:<port>
• API v2文档：访问http://<host>:<port>/v2

Prometheus指标

启用指标收集：

• 使用--enablemetrics标志
• 或设置环境变量PROM2TEAMS_PROMETHEUS_METRICS=true

指标端点：http://<host>:<port>/metrics，包含请求数、响应状态等监控指标。

版本兼容性

• 已测试环境：Prometheus 2.2.1、Python 3.8.0、pip 9.0.1
• 建议使用带版本标签的Docker镜像，如idealista/prom2teams:2.4.0

许可证

本项目基于Apache 2.0许可证开源，详见https://github.com/idealista/prom2teams/blob/master/LICENSE%E3%80%82