line/promgen

Promgen 镜像文档

概述

Promgen是一个为Prometheus设计的配置文件生成器，是基于Django开发的Web应用。它主要用于帮助用户创建和管理Prometheus配置文件，配置告警规则及通知选项，提供直观的Web界面简化Prometheus的配置管理流程。

核心功能和特性

• 创建和管理Prometheus配置文件
• 配置告警规则和通知选项

使用场景

• 需要集中管理多个Prometheus实例配置的环境
• 需要通过Web界面简化告警规则配置的团队
• 希望标准化Prometheus配置流程的组织
• 需要降低手动编辑Prometheus配置文件出错风险的场景

使用方法

1. 初始化Promgen

创建配置目录

bash
# 创建promgen设置目录
mkdir -p ~/.config/promgen
chmod 777 ~/.config/promgen

初始化配置设置

bash
# 使用Docker容器初始化必要设置
# 此命令会提示您输入数据库和Redis broker的连接设置（使用标准DSN语法）
# 数据库示例：mysql://username:password@hostname/databasename
# Broker示例：redis://localhost:6379/0
docker run --rm -it -v ~/.config/promgen:/etc/promgen/ line/promgen bootstrap

应用数据库更新

bash
# 应用数据库更新
docker run --rm -v ~/.config/promgen:/etc/promgen/ line/promgen migrate

创建管理员用户

bash
# 创建初始登录用户（与Django的django-admin createsuperuser命令功能相同）
# 参考：https://docs.djangoproject.com/en/1.10/ref/django-admin/#django-admin-createsuperuser
docker run --rm -it -v ~/.config/promgen:/etc/promgen/ line/promgen createsuperuser

2. 配置Prometheus

配置Prometheus以加载Promgen生成的目标文件，并设置AlertManager将通知发送回Promgen。参考以下示例配置文件进行配置：

• https://github.com/line/promgen/blob/master/promgen/tests/examples/promgen.yml
• https://github.com/line/promgen/blob/master/docker/prometheus.yml
• https://github.com/line/promgen/blob/master/docker/alertmanager.yml

3. 运行Promgen

运行Web服务

bash
# 运行Promgen Web服务（通常在NGINX实例后进行负载均衡）
docker run --rm -p 8000:8000 -v ~/.config/promgen:/etc/promgen/ line/promgen

运行Celery Worker

bash
# 运行Promgen Celery Worker（确保与Prometheus服务器在同一台机器上以管理配置）
docker run --rm -v ~/.config/promgen:/etc/promgen/ -v /etc/prometheus:/etc/prometheus line/promgen worker

使用Docker Compose

bash
# 使用docker-compose启动完整测试环境
docker-compose up -d
# 创建初始用户
docker-compose run web createsuperuser

注意事项

• 配置目录权限：~/.config/promgen需设置777权限以确保容器可写入配置文件
• 数据持久化：通过挂载~/.config/promgen目录确保配置信息持久化存储
• 数据库和Broker：初始化时需正确提供数据库（如MySQL）和Redis Broker的DSN连接字符串，确保服务正常运行
• 安全考虑：生产环境中建议限制配置目录访问权限，避免使用777权限，可通过指定用户ID运行容器增强安全性