prometheus-pve-sd

Prometheus Service Discovery for Proxmox VE

![Build Status]([] ![Docker Hub]([] ![Quay.io]([] ![Python Version]([] ![PyPI Status]([] ![PyPI Release]([] ![GitHub contributors]([] ![Source: GitHub]([] ![License: MIT]([***]

镜像概述和主要用途

prometheus-pve-sd是一个为Prometheus设计的简单自定义服务发现工具。它通过调用Proxmox VE (PVE) API获取主机及其元信息，生成Prometheus兼容的基于文件的服务发现配置。该工具以Python包形式发布于GitHub和PyPI，同时提供Docker镜像版本，可从Docker Hub获取。

完整文档可访问[***]

核心功能和特性

• PVE API集成：通过Proxmox VE API自动获取主机及其元数据（如IP地址、状态等）
• Prometheus兼容输出：生成符合Prometheus规范的基于文件的服务发现配置
• 多平台支持：提供Python包和Docker镜像，适应不同部署需求
• 自动化发现：减少手动配置Prometheus监控目标的工作量，提升监控覆盖率

使用场景和适用范围

适用于采用Proxmox VE管理虚拟化环境，且使用Prometheus进行监控的场景。通过该工具，可实现PVE环境中主机的自动发现，确保Prometheus能动态监控新增或变更的PVE主机，尤其适合虚拟化环境规模较大或主机频繁变动的场景。

使用方法和配置说明

Docker部署示例

基本运行命令

bash
docker run -d \
  --name prometheus-pve-sd \
  -e PVE_API_URL="[***]" \
  -e PVE_USER="your-pve-user@pam" \
  -e PVE_PASSWORD="your-pve-password" \
  -v /path/to/prometheus/sd-config:/output \
  thegeeklab/prometheus-pve-sd

参数说明

• PVE_API_URL：Proxmox VE API地址（格式为https://<pve-server>:8006/api2/json）
• PVE_USER：PVE认证用户（需包含认证域，如user@pam）
• PVE_PASSWORD：PVE用户密码
• 挂载卷/output：生成的服务发现配置文件将输出至此目录，Prometheus需配置从该目录读取文件式服务发现配置

详细配置参数（如过滤规则、刷新间隔等）请参考***文档。

贡献者

特别感谢所有贡献者。如需参与贡献，请参阅贡献指南。

许可证

本项目采用MIT许可证 - 详见LICENSE文件。