relaysh/alertmanager-trigger-alert-fired

alertmanager-trigger-alert-fired镜像描述

镜像概述

本镜像为Relay平台提供webhook触发器功能，用于接收Prometheus Alertmanager发送的警报事件（包括触发和已解决状态），并将警报载荷封装到event_payload结构中，方便后续工作流步骤解析和使用。

核心功能

• 监听Alertmanager的HTTP POST请求，捕获警报事件
• 将原始警报载荷封装为event_payload，简化工作流数据处理
• 兼容Alertmanager的send_resolved（是否发送已解决警报）、max_alerts（单次消息最大警报数）等配置参数

使用场景

• 当Prometheus监控系统检测到服务异常（如宕机、资源超限）时，触发Alertmanager发送警报到Relay工作流
• 结合Relay工作流实现警报自动化处理（如发送通知、执行修复脚本、记录日志等）

配置说明

Alertmanager配置步骤

1. 从Relay触发器获取专属webhook URL
2. 编辑Alertmanager配置文件，添加webhook接收器：

yaml
receivers:
  - name: relay
    webhook_configs:
      - url: <你的Relay webhook URL>
        send_resolved: true  # 可选，默认发送已解决警报
        max_alerts: 0        # 可选，0表示无限制单次警报数

3. 调整Alertmanager路由规则，确保警报正确路由到该接收器

Relay工作流示例

以下是使用该触发器的Relay工作流配置示例：

yaml
parameters:
  event_payload:
    description: "Alertmanager警报的完整JSON载荷"
triggers:
  - name: alertmanager-event
    source:
      type: webhook
      image: relaysh/alertmanager-trigger-alert-fired
    binding:
      parameters:
        event_payload: !Data event_payload
steps:
  - name: 打印警报载荷
    image: relaysh/core
    spec:
      event_payload: !Parameter event_payload
    input:
      - mkdir -p /workflow
      - "ni get | jq .event_payload > /workflow/alert.json"
      - cat /workflow/alert.json

示例载荷结构

警报事件的典型JSON载荷格式如下：

json
{
  "version": "4",
  "groupKey": "<string>",
  "truncatedAlerts": <int>,
  "status": "<resolved|firing>",
  "receiver": "<string>",
  "groupLabels": {},
  "commonLabels": {},
  "commonAnnotations": {},
  "externalURL": "<string>",
  "alerts": [
    {
      "status": "<resolved|firing>",
      "labels": {},
      "annotations": {},
      "startsAt": "<rfc3339>",
      "endsAt": "<rfc3339>",
      "generatorURL": "<string>"
    }
  ]
}