prom/consul-exporter

Consul Exporter

镜像概述和主要用途

Consul Exporter用于将Consul的服务健康状态、集群信息、节点状态及键值存储等指标导出至Prometheus，实现对Consul集群的监控与可观测性。

核心功能和特性

• 导出Consul集群核心指标：包括Raft集群节点数、Serf LAN/WAN成员状态、服务目录数量等
• 服务健康监控：支持服务健康检查状态、节点健康状态的指标采集
• 键值存储指标：可导出Consul KV存储中指定键的数值型值
• 灵活配置：支持通过命令行参数、环境变量配置Consul连接参数（如TLS、ACL令牌、超时时间等）
• 本地代理模式：可仅导出本地Consul代理注册的服务指标
• 健康摘要：收集服务健康状态并生成聚合指标，支持快速判断服务整体健康性

使用场景和适用范围

适用于基于Consul进行服务发现与配置管理的环境，需将Consul集群运行状态、服务可用性、节点健康等指标集成到Prometheus监控体系的场景，尤其适合：

• Consul集群运维监控
• 服务健康状态实时监控
• 跨数据中心Consul节点状态监控
• 基于Consul KV存储的配置参数监控

详细的使用方法和配置说明

Docker部署

拉取镜像

bash
docker pull prom/consul-exporter

基本运行命令

bash
docker run -d -p 9107:9107 prom/consul-exporter --consul.server=172.17.0.1:8500

带DNS配置的运行示例

当容器需通过域名访问Consul时，可配置DNS参数：

bash
docker run -d -p 9107:9107 \
  --dns=172.17.0.1 \
  --dns-search=service.consul \
  prom/consul-exporter --consul.server=consul:8500

Docker Compose配置示例

yaml
version: '3'
services:
  consul-exporter:
    image: prom/consul-exporter
    container_name: consul-exporter
    ports:
      - "9107:9107"
    command:
      - --consul.server=consul:8500
      - --consul.allow-stale=true
      - --consul.timeout=10s
      - --web.telemetry-path=/metrics
      - --log.level=info
    environment:
      - CONSUL_HTTP_TOKEN=your-acl-token-here
    depends_on:
      - consul

  consul:
    image: consul:latest
    container_name: consul
    ports:
      - "8500:8500"
    command: agent -server -bootstrap -client=0.0.0.0

配置参数

命令行参数

KV存储指标配置

环境变量

支持Consul官方consul/api包定义的所有环境变量，主要包括：

导出的指标

常用查询

服务健康状态汇总

promql
min(consul_catalog_service_node_healthy) by (service_name)

说明：值为1表示服务所有节点健康；值为0表示至少一个节点不健康。

失败的服务节点

promql
sum by (node, service_name)(consul_catalog_service_node_healthy == 0)

处于critical状态的服务检查

promql
consul_health_service_status{status="critical"} == 1

支持的状态值：maintenance（维护中）、critical（严重）、warning（警告）、passing（正常）

TLS和基本认证

通过--web.config.file参数指定配置文件启用TLS和基本认证，配置文件格式详见https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md%E3%80%82