lmierzwa/karma

karma

概述和主要用途

karma是Prometheus Alertmanager的告警仪表盘。Alertmanager UI虽可用于浏览告警和管理静默，但作为仪表盘工具存在不足，karma旨在填补这一空白。从0.7.0版本开始，它还能聚合多个Alertmanager实例（无论是HA模式还是独立运行）的告警，对重复告警进行去重，仅显示唯一告警。每个告警会标记其来自的所有Alertmanager实例名称，并可基于这些标签（@alertmanager）进行筛选（仅当配置多个Alertmanager实例时可见）。

!截图

告警按Alertmanager中group_by配置选项分组展示。如果一个组包含多个告警，仅显示前几个，其余可通过-/+按钮展开或隐藏。默认告警数量可在UI设置模块中配置。每个单独的告警仅显示唯一的标签和注解，所有告警共享的标签和注解将移至页脚。示例：

!示例

每个组可使用右上角的切换图标折叠为仅显示标题栏。

在线演示

若要获取karma新版本通知，可订阅GitHub提供的RSS feed https://github.com/prymitive/karma/releases.atom%E3%80%82%E5%A6%82%E9%9C%80%E9%82%AE%E4%BB%B6%E9%80%9A%E7%9F%A5%EF%BC%8C%E8%AF%B7%E4%BD%BF%E7%94%A8%E6%8F%90%E4%BE%9B%E2%80%9CRSS%E8%BD%AC%E9%82%AE%E4%BB%B6%E2%80%9D%E9%80%9A%E7%9F%A5%E7%9A%84%E5%85%8D%E8%B4%B9%E6%9C%8D%E5%8A%A1%EF%BC%8C%E5%A6%82Blogtrottr%E3%80%82

核心功能和特性

• 多实例聚合：支持从多个Alertmanager实例收集告警，适用于HA模式或独立部署场景。
• 告警去重：自动识别并移除重复告警，仅展示唯一告警内容。
• 分组展示：严格遵循Alertmanager的group_by配置，按规则分组展示告警。
• 智能信息展示：组内共享标签和注解移至页脚，单个告警仅显示独特信息，提升可读性。
• 实例标签筛选：通过@alertmanager标签筛选不同来源实例的告警（多实例配置时可用）。
• UI可配置：支持自定义默认展示告警数量等界面参数。

历史

karma由作者在Cloudflare工作期间创建，最初名为https://github.com/cloudflare/unsee%E3%80%82%E8%AF%A5%E9%A1%B9%E7%9B%AE%E5%9F%BA%E4%BA%8E%E5%8E%9F%E4%BB%A3%E7%A0%81%E9%87%8D%E6%9E%84%EF%BC%8C%E4%BD%BF%E7%94%A8React%E4%BB%8E%E9%9B%B6%E9%87%8D%E5%86%99UI%E5%B1%82%EF%BC%8C%E5%90%8E%E7%AB%AFAPI%E4%B9%9F%E8%BF%9B%E8%A1%8C%E4%BA%86%E4%B8%8D%E5%85%BC%E5%AE%B9%E5%8F%98%E6%9B%B4%E3%80%82%E7%94%B1%E4%BA%8EReact%E9%87%8D%E5%86%99%E5%AF%BC%E8%87%B4%E7%BA%A650%25%E7%9A%84%E4%BB%A3%E7%A0%81%E6%9B%B4%E6%96%B0%EF%BC%8C%E4%B8%94%E5%8E%9F%E9%A1%B9%E7%9B%AE%E5%B7%B2%E5%81%9C%E6%AD%A2%E7%BB%B4%E6%8A%A4%EF%BC%8C%E4%B8%BA%E9%81%BF%E5%85%8D%E7%94%A8%E6%88%B7%E6%B7%B7%E6%B7%86%EF%BC%8C%E6%AD%A3%E5%BC%8F%E6%9B%B4%E5%90%8D%E4%B8%BAkarma%E3%80%82

支持的Alertmanager版本

Alertmanager的API尚未稳定，不同版本间可能存在差异。支持的所有版本列表参见internal/mock/Makefile中的VERSIONS。受API差异影响，部分功能可能表现不同或缺失，建议使用最新支持的Alertmanager版本。

安全

karma进程不会向Alertmanager发送修改告警或静默状态的API请求，但Web界面允许用户直接向Alertmanager API发送此类请求。若部署为只读工具，需确保：

• karma进程可连接Alertmanager API
• 只读用户可访问karma Web界面
• 只读用户无法直接连接Alertmanager API

指标

karma进程指标默认通过/metrics路径暴露。若设置--listen.prefix选项，则使用相对于该前缀的路径。

构建和运行

从源码构建

克隆仓库并构建二进制文件：

bash
git clone https://github.com/prymitive/karma $GOPATH/src/github.com/prymitive/karma
cd $GOPATH/src/github.com/prymitive/karma

编译karma：

bash
make

注意：本地构建需依赖Go、nodejs和yarn环境。

运行

支持通过配置文件、命令行标志或环境变量配置。单实例场景推荐使用环境变量或命令行标志：

bash
# 环境变量方式
ALERTMANAGER_URI=https://alertmanager.example.com karma

# 命令行标志方式
karma --alertmanager.uri https://alertmanager.example.com

使用make目标快速运行（默认监听8080端口，使用模拟数据）：

bash
make run

# 自定义端口和Alertmanager地址
make PORT=5000 ALERTMANAGER_URI=https://alertmanager.example.com run

Docker

运行预构建镜像

官方镜像托管于https://hub.docker.com/r/lmierzwa/karma/%EF%BC%8C%E8%87%AA%E5%8A%A8%E6%9E%84%E5%BB%BA%E6%A0%87%E7%AD%BE%E5%8C%85%E6%8B%AC%EF%BC%9A

• 发布版本：lmierzwa/karma:vX.Y.Z（对应git标签）
• 开发版本：lmierzwa/karma:latest（对应master分支最新提交）

示例

启动发布版本：

bash
docker run -e ALERTMANAGER_URI=https://alertmanager.example.com lmierzwa/karma:vX.Y.Z

启动开发版本（不推荐生产环境）：

bash
docker run -e ALERTMANAGER_URI=https://alertmanager.example.com lmierzwa/karma:latest

构建Docker镜像

bash
make docker-image

运行本地构建镜像

bash
make run-docker

# 自定义配置
make PORT=5000 ALERTMANAGER_URI=https://alertmanager.example.com run-docker

配置

完整配置选项参见CONFIGURATION，配置文件示例参见example.yaml。

贡献

详情参见CONTRIBUTING。

许可证

Apache License 2.0，详见LICENSE。