cloudflare/unsee

unsee

Prometheus Alertmanager的告警仪表盘。

Alertmanager UI在浏览告警和管理静默方面很有用，但作为仪表盘工具存在不足——unsee旨在填补这一空白。从0.7.0版本开始，它还可以聚合来自多个Alertmanager实例（无论是HA模式还是独立运行）的告警。重复的告警会被去重，因此只显示唯一告警。每个告警都标记有发现它的所有Alertmanager实例名称，并可基于这些标签进行过滤。

支持的Alertmanager版本

Alertmanager的API尚未稳定，可能在版本之间发生变化。有关unsee测试和支持的所有Alertmanager版本列表，请参见internal/mock/Makefile中的VERSIONS。由于这些版本之间的API差异，某些功能可能会有不同的工作方式或缺失，建议使用最新支持的Alertmanager版本。

安全性

unsee进程不会向Alertmanager发送任何可能修改告警或静默状态的API请求，但它提供的Web界面允许用户直接向Alertmanager API发送此类请求。如果希望将unsee部署为只读工具，请确保：

• unsee进程能够连接到Alertmanager API
• 只读用户能够连接到unsee Web界面
• 只读用户不能连接到Alertmanager API

指标

unsee进程指标默认可通过/metrics路径访问。如果设置了--listen.prefix选项，则会使用相对于该前缀的路径。

构建和运行

从源码构建

要克隆git仓库并自行构建二进制文件，请运行：

bash
git clone https://github.com/cloudflare/unsee $GOPATH/src/github.com/cloudflare/unsee
cd $GOPATH/src/github.com/cloudflare/unsee

要最终编译unsee二进制文件，请运行：

bash
make

注意，从源码本地构建需要Go、nodejs和npm。有关在Docker容器中构建的说明，请参见下面的Docker构建选项。

运行

unsee可通过配置文件、命令行标志或环境变量进行配置。推荐使用配置文件，这也是配置unsee使用多个Alertmanager服务器收集告警的唯一方式。要使用单个Alertmanager服务器运行unsee，可设置ALERTMANAGER_URI环境变量或在命令行上传递--alertmanager.uri标志，并指定Alertmanager URI作为参数，示例：

bash
ALERTMANAGER_URI=https://alertmanager.example.com unsee
unsee --alertmanager.uri https://alertmanager.example.com

有一个make目标可编译并运行unsee：

bash
make run

默认情况下，它会监听端口8080并使用Alertmanager模拟数据。要覆盖Alertmanager URI，请设置ALERTMANAGER_URI和/或PORT make变量。示例：

bash
make PORT=5000 ALERTMANAGER_URI=https://alertmanager.example.com run

Docker

运行预构建的Docker镜像

官方Docker镜像在https://hub.docker.com/r/cloudflare/unsee/构建和托管。

镜像会自动为以下情况构建：

• git中的发布标签 - cloudflare/unsee:vX.Y.Z
• master分支提交 - cloudflare/unsee:latest

示例

要启动发布镜像，请运行：

bash
docker run -e ALERTMANAGER_URI=https://alertmanager.example.com docker.xuanyuan.run/cloudflare/unsee:vX.Y.Z

最新发布详情可在https://github.com/cloudflare/unsee/releases上找到。

要启动从最新master分支构建的Docker镜像，请运行：

bash
docker run -e ALERTMANAGER_URI=https://alertmanager.example.com docker.xuanyuan.run/cloudflare/unsee:latest

注意，最新的master分支可能存在bug或破坏性变更。对于任何生产用途，强烈建议使用发布镜像。

构建Docker镜像

bash
make docker-image

这将从源码构建Docker镜像。

运行Docker镜像

bash
make run-docker

将运行本地构建的Docker镜像。与make run具有相同的默认值和覆盖变量。示例：

bash
make PORT=5000 ALERTMANAGER_URI=https://alertmanager.example.com run-docker

配置

有关所有可用配置选项的完整列表，请参见CONFIGURATION，配置文件示例请参见example.yaml。

贡献

详情请参见CONTRIBUTING。

许可证

Apache License 2.0，详情请参见LICENSE。