messagebird/gcppromd

GCPPromd Docker镜像文档

镜像概述

GCPPromd是一个专为Prometheus设计的工具，用于实现Google Compute Engine（GCE）实例的自动发现。它解决了在动态扩展的GCE环境中，Prometheus手动配置监控目标的痛点，能够自动识别和更新GCE实例信息，确保Prometheus监控目标实时准确。

核心功能与特性

• GCE实例自动发现：自动探测指定GCP项目中的GCE实例，无需手动维护目标列表
• 与Prometheus无缝集成：输出符合Prometheus服务发现格式的目标信息
• 灵活的过滤机制：支持按标签、区域、实例状态等条件过滤实例
• 轻量级部署：通过Docker容器化部署，资源占用低，易于集成到现有监控架构

使用场景与适用范围

• 基于GCP GCE服务构建的云环境监控
• 动态扩展的GCE实例集群（如自动扩缩组）监控
• 需要自动化Prometheus目标配置的场景
• 减少手动配置和维护Prometheus监控目标的工作量

使用方法与配置说明

基本使用（Docker Run）

bash
docker run -d \
  --name gcppromd \
  -e GCP_PROJECT=your-gcp-project-id \
  -e GCP_REGION=us-central1 \
  -v /path/to/gcp-credentials.json:/app/credentials.json \
  -e GOOGLE_APPLICATION_CREDENTIALS=/app/credentials.json \
  messagebird/gcppromd

环境变量配置

与Prometheus集成

在Prometheus配置文件（prometheus.yml）中添加以下内容：

yaml
scrape_configs:
  - job_name: 'gce-instances'
    http_sd_configs:
      - url: 'http://gcppromd:9233/sd'
    relabel_configs:
      - source_labels: [__meta_gce_instance_name]
        target_label: instance
      - source_labels: [__meta_gce_instance_labels]
        regex: .*env=(.*);.*
        target_label: environment

Docker Compose示例

yaml
version: '3'
services:
  gcppromd:
    image: messagebird/gcppromd
    environment:
      - GCP_PROJECT=your-gcp-project-id
      - GCP_REGION=us-central1
      - GOOGLE_APPLICATION_CREDENTIALS=/app/credentials.json
      - FILTER=labels.monitor=true
      - REFRESH_INTERVAL=60
    volumes:
      - ./gcp-credentials.json:/app/credentials.json
    ports:
      - "9233:9233"

  prometheus:
    image: prom/prometheus
    volumes:
      - ./prometheus.yml:/etc/prometheus/prometheus.yml
    ports:
      - "9090:9090"
    depends_on:
      - gcppromd

注意事项

• 确保GCP凭证文件具有足够权限（至少需要compute.instances.list权限）
• 网络配置需保证Prometheus能够访问GCPPromd服务端口
• 对于多区域部署，可省略GCP_REGION环境变量以发现所有区域实例