alerta/alerta-web

Alerta Docker镜像文档

镜像概述和主要用途

Alerta监控系统是一款用于整合和去重多个来源警报的工具，提供快速概览可视化功能。通过单一系统，用户可以在单个屏幕上监控来自多种监控工具的警报，实现集中化的警报管理。

核心功能和特性

• 警报整合与去重：从多个来源收集警报并自动去重，避免重复告警
• 多源监控支持：兼容多种监控工具，实现集中化监控
• 概览可视化：提供直观的Web控制台，便于快速查看警报状态
• 多数据库支持：支持MongoDB和PostgreSQL作为后端数据库
• 灵活认证机制：支持Basic Auth、LDAP、OAuth2（Google、GitHub、GitLab等）、SAML2、Keycloak等多种认证方式
• 插件扩展：支持多种内置和第三方插件，可按需启用
• 环境变量配置：通过环境变量轻松配置系统参数
• Docker化部署：支持容器化部署，便于快速搭建和扩展

使用场景和适用范围

Alerta适用于需要集中管理多个监控工具（如Prometheus、Nagios、Zabbix等）警报的场景，特别适合IT运维团队、DevOps工程师和系统管理员，帮助他们快速发现、分析和处理系统异常。

详细使用方法和配置说明

基本使用方法

使用Alerta镜像前，需先运行MongoDB或PostgreSQL数据库容器：

bash
# 启动MongoDB数据库容器
$ docker run --name alerta-db -d mongo

然后链接数据库容器运行Alerta Web容器：

bash
$ export DATABASE_URL=mongodb://db:27017/monitoring
$ docker run --name alerta-web -e DATABASE_URL=$DATABASE_URL --link alerta-db:db \
  -d -p <port>:8080 alerta/alerta-web

• API端点：http://<docker>:<port>/api
• Web控制台：http://<docker>:<port>/

环境变量配置

Docker部署特定环境变量

Alerta API通用环境变量

配置文件

对于环境变量不支持的配置设置，可使用配置文件：

bash
$ docker run -v $PWD/config/alertad.conf:/app/alertad.conf \
  -v $PWD/config/config.json:/web/config.json \
  -p <port>:8080 alerta/alerta-web

完整的服务器配置选项请参见Alerta文档。

插件

所有内置和贡献的插件在镜像构建时已安装，仅PLUGINS环境变量中列出的插件会被启用。

示例（仅启用列出的插件）：

bash
PLUGINS=remote_ip,reject,heartbeat,blackout,slack,prometheus

自定义插件应作为额外的镜像层安装。

认证配置

默认镜像使用Basic Auth进行用户登录，且登录为可选。

Google OAuth认证

1. 在Google开发者控制台创建Web应用的客户端ID
2. 设置环境变量：

   bash
   $ export CLIENT_ID=379647311730-6tfdcopl5fodke08el52nnoj3x8mpl3.apps.googleusercontent.com
   $ export CLIENT_SECRET=UpJxs02c_bx9GlI3X8MPL3-p
   

3. 运行容器：

   bash
   $ docker run --name alerta-web -e AUTH_PROVIDER=google -e CLIENT_ID=$CLIENT_ID \
     -e CLIENT_SECRET=$CLIENT_SECRET -d -p <port>:8080 alerta/alerta-web
   

强制登录

设置AUTH_REQUIRED=True强制用户登录：

bash
$ docker run --name alerta-web -e AUTH_REQUIRED=True -e ...

限制电子邮件域名

设置ALLOWED_EMAIL_DOMAIN限制登录域名：

bash
$ docker run --name alerta-web -e ALLOWED_EMAIL_DOMAIN=example.com ...

其他OAuth2提供程序

• GitHub：设置AUTH_PROVIDER=github
• GitLab：设置AUTH_PROVIDER=gitlab

更多信息参见Alerta文档。

Docker Compose配置

使用docker-compose一键创建和启动Alerta与Postgres：

bash
$ docker-compose up

示例Docker Compose文件：

yaml
version: '2.1'
services:
  web:
    image: alerta/alerta-web
    ports:
      - "8080:8080"
    depends_on:
      - db
    environment:
      - DEBUG=1  # 移除此行以关闭DEBUG模式
      - DATABASE_URL=postgres://postgres:postgres@db:5432/monitoring
      - AUTH_REQUIRED=True
      - ADMIN_USERS=admin@alerta.io,devops@alerta.io # 默认密码: alerta
      - ADMIN_KEY=demo-key
      - PLUGINS=reject,blackout,normalise,enhance
    restart: always
  db:
    image: postgres
    volumes:
      - ./pg-data:/var/lib/postgresql/data
    environment:
      POSTGRES_DB: monitoring
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: postgres
    restart: always

命令行工具

安装Alerta命令行工具：

bash
$ pip install alerta

配置文件$HOME/.alerta.conf：

ini
[DEFAULT]
endpoint = http://<docker>:<port>/api

若启用认证（AUTH_REQUIRED=True），需在Alerta控制台创建API密钥并添加到配置文件：

ini
[DEFAULT]
endpoint = ...
key = 4nHAAslsGjLQ9P0QxmAlKIapLTSDfEfMDSy8BT+0

进一步阅读

更多关于Alerta的信息请参见Alerta文档。

许可证

版权所有 (c) 2014-2020 Nick Satterly。采用MIT许可证。