stucky/prometheus-docker-sd

prometheus-docker-sd

镜像概述和主要用途

prometheus-docker-sd是一款用于Docker容器的Prometheus服务发现工具。它通过监听Docker守护进程，基于容器标签识别需要监控的容器，并自动生成Prometheus兼容的目标配置文件（docker-targets.json），实现Docker环境下的动态服务发现，无需手动配置Prometheus监控目标。

核心功能和特性

• 基于Docker标签的服务发现：通过容器标签指定需要监控的容器，灵活控制监控范围
• 自动生成配置文件：实时生成Prometheus file_sd_configs格式的目标配置文件
• 支持自定义监控参数：可通过标签配置监控作业名、端口、协议、指标路径等
• 无缝集成Prometheus：生成的配置文件可直接被Prometheus读取，无需额外适配
• 轻量级运行：仅需挂载Docker套接字即可工作，资源占用低

使用场景和适用范围

• 动态Docker环境：适用于容器频繁启停、扩缩容的场景，自动更新监控目标
• 容器化应用监控：为Docker容器化的微服务、应用程序提供自动监控配置
• 简化监控管理：减少手动配置Prometheus target的工作量，降低人为错误
• DevOps环境：与CI/CD流程结合，实现新部署容器的自动监控接入

使用方法和配置说明

准备工作

首先创建必要的网络，确保Prometheus与被监控容器在同一网络中：

bash
docker network create monitoring_ext

Docker Compose配置示例

以下是包含Prometheus和prometheus-docker-sd的完整docker-compose.yml配置：

yaml
version: '2'
services:

  # Prometheus服务
  prometheus:
    image: "prom/prometheus:v2.25.0"
    restart: unless-stopped
    networks:
      - monitoring_ext
    expose:
      - "9090"
    ports:
      - "19090:9090"
    volumes:
      - ./prometheus/config:/etc/prometheus:ro  # Prometheus配置目录
      - ./prometheus/data:/prometheus:rw        # Prometheus数据目录
      - prometheus-docker-sd:/prometheus-docker-sd:ro  # 挂载服务发现配置文件目录
    command: [
      "--config.file=/etc/prometheus/prometheus.yml",
      "--storage.tsdb.path=/prometheus",
      "--storage.tsdb.retention.time=15d",
      "--web.console.libraries=/usr/share/prometheus/console_libraries",
      "--web.console.templates=/usr/share/prometheus/consoles"
    ]

  # prometheus-docker-sd服务
  prometheus-docker-sd:
    image: "stucky/prometheus-docker-sd:latest"
    restart: unless-stopped
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock  # 挂载Docker套接字以监听容器事件
      - prometheus-docker-sd:/prometheus-docker-sd:rw  # 生成的配置文件输出目录

volumes:
  prometheus-docker-sd:  # 用于共享服务发现配置文件的卷

networks:
  monitoring_ext:
    external: true
    name: monitoring_ext  # 使用已创建的监控网络

Prometheus配置修改

在Prometheus配置文件（prometheus.yml）中添加以下抓取配置，以读取prometheus-docker-sd生成的目标文件：

yaml
scrape_configs:
  - job_name: 'service_discovery'
    file_sd_configs:
      - files:
          - /prometheus-docker-sd/docker-targets.json  # 指向生成的目标配置文件

容器标签说明

需监控的容器需添加以下标签，prometheus-docker-sd将根据标签生成监控目标：

重要：被监控容器必须与Prometheus在同一网络（monitoring_ext）中，以确保Prometheus能够访问容器的指标端点。

使用示例

使用docker run运行node-exporter示例

bash
docker run -d \
  --name="node-exporter" \
  --pid="host" \
  -v /:/host:ro \
  --network=monitoring_ext \  # 加入监控网络
  -l prometheus-scrape.enabled=true \  # 启用监控
  -l prometheus-scrape.job_name="node-exporter" \  # 设置作业名称
  -l prometheus-scrape.port=9100 \  # node-exporter默认端口
  -l prometheus-scrape.metrics_path="/metrics" \  # 指标路径
  quay.io/prometheus/node-exporter \
  --path.rootfs=/host

使用docker-compose运行node-exporter示例

yaml
version: '2'
services:
  node-exporter:
    image: prom/node-exporter:latest
    restart: unless-stopped
    networks:
      - internal
      - monitoring_ext  # 加入监控网络
    labels:
      prometheus-scrape.enabled: "true"          # 启用监控
      prometheus-scrape.job_name: "node-exporter" # 作业名称
      prometheus-scrape.port: 9100               # 端口
      prometheus-scrape.metrics_path: "/metrics" # 指标路径
    volumes:
      - /proc:/rootfs/proc:ro
      - /sys:/rootfs/sys:ro
      - /:/rootfs:ro
    expose:
      - "9100"

networks:
  internal:
  monitoring_ext:
    external: true
    name: monitoring_ext  # 使用外部监控网络