Prometheus Service Discovery

·

Promsd 采集器支持通过各类服务发现动态获取监控目标，并采集 Exporters 暴露的指标数据。

配置¶

主机安装Kubernetes

进入 DataKit 安装目录下的 conf.d/samples 目录，复制 promsd.conf.sample 并命名为 promsd.conf。示例如下：

[[inputs.promsd]]
  ## Collector alias identifier
  source = "prom_sd"

  # ============================================================================
  # Service Discovery Configuration
  # ============================================================================
  # Choose one of the following service discovery methods:

  ## File-based Service Discovery
  # [inputs.promsd.file_sd_config]
  #   ## Files patterns to read target groups from (supports glob patterns)
  #   files = ["/etc/prometheus/targets/*.json", "/path/to/targets.yaml"]
  #   ## Refresh interval for re-reading files
  #   refresh_interval = "5m"

  ## HTTP-based Service Discovery
  # [inputs.promsd.http_sd_config]
  #   ## Service discovery endpoint URL
  #   service_url = "http://your-sd-service:8080/prometheus/targets"
  #   ## Refresh interval for fetching targets from HTTP endpoint
  #   refresh_interval = "5m"
  #
  #   ## Optional: Custom HTTP headers
  #   [inputs.promsd.http_sd_config.http_headers]
  #     # X-Custom-Header = "value"
  #
  #   ## Optional: Authentication and TLS configuration
  #   [inputs.promsd.http_sd_config.auth]
  #     ## Bearer token file for authentication (automatically adds Authorization header)
  #     bearer_token_file = "/path/to/token"
  #
  #     ## TLS Configuration
  #     # insecure_skip_verify = false
  #     # ca_certs = ["/opt/tls/ca.crt"]
  #     # cert     = "/opt/tls/client.crt"
  #     # cert_key = "/opt/tls/client.key"

  ## Consul Service Discovery
  # [inputs.promsd.consul_sd_config]
  #   ## Consul server address (format: host:port)
  #   server = "localhost:8500"
  #   ## API path prefix when Consul is behind reverse proxy
  #   path_prefix = ""
  #   ## ACL token for authentication (use environment variables for security)
  #   token = ""
  #   ## Datacenter to query (empty for default)
  #   datacenter = ""
  #   ## Namespace for tenant isolation
  #   namespace = "default"
  #   ## Administrative partition
  #   partition = ""
  #   ## Protocol scheme (http or https)
  #   scheme = "http"
  #   ## Services to monitor (empty array monitors all services)
  #   services = []
  #   ## Native Consul filter expression (deprecated tags/node_meta replacement)
  #   # Example: 'Service.Tags contains "metrics" and Node.Meta.rack == "a1"'
  #   filter = ""
  #   ## Enable stale results to reduce Consul cluster load
  #   allow_stale = true
  #   ## Refresh interval for service discovery targets
  #   refresh_interval = "5m"
  #
  #   ## Optional: Authentication and TLS configuration
  #   [inputs.promsd.consul_sd_config.auth]
  #     ## Bearer token file for authentication
  #     bearer_token_file = "/path/to/token"
  #
  #     ## TLS Configuration
  #     # insecure_skip_verify = false
  #     # ca_certs = ["/opt/tls/ca.crt"]
  #     # cert     = "/opt/tls/client.crt"
  #     # cert_key = "/opt/tls/client.key"

  # ============================================================================
  # Scrape Configuration
  # ============================================================================
  [inputs.promsd.scrape]
    ## Protocol scheme for target connections
    scheme = "http"

    ## Metrics endpoint path
    metrics_path = "/metrics"

    ## Query parameters in URL-encoded format
    ## Format: "key1=value1&key2=value2"
    ## Example: "debug=true&module=http"
    params = ""

    ## Scraping interval
    interval = "30s"

    ## Optional: Custom HTTP headers
    [inputs.promsd.scrape.http_headers]
      # Authorization = "Bearer <token>"
      # X-Custom-Header = "value"

    ## Optional: Authentication and TLS configuration
    [inputs.promsd.scrape.auth]
      ## Bearer token file for authentication (automatically adds Authorization header)
      bearer_token_file = ""

      ## TLS Configuration
      # insecure_skip_verify = false
      # ca_certs = ["/opt/tls/ca.crt"]
      # cert     = "/opt/tls/client.crt"
      # cert_key = "/opt/tls/client.key"

  # ============================================================================
  # Additional Tags
  # ============================================================================
  [inputs.promsd.tags]
    # cluster = "production"
    # region  = "us-east-1"
    # team    = "platform"

配置好后，重启 DataKit 即可。

目前可以通过 ConfigMap 方式注入采集器配置来开启采集器。

基础采集配置¶

配置数据拉取的 HTTP 请求行为：

[inputs.promsd.scrape]
  ## 目标连接协议（http/https）
  scheme = "http"
  ## 指标访问路径（默认是 /metrics）
  metrics_path = "/metrics"
  ## URL 访问参数
  ## Format: "key1=value1&key2=value2&key3=value3"
  ## Example: "debug=true&module=http"
  params = ""

  ## 采集间隔（默认 "30s"）
  interval = "30s"

  ## 自定义 HTTP 请求头（示例：Basic Auth）
  [inputs.promsd.scrape.http_headers]
    # Authorization = "Bearer <TOKEN>"

  ## 认证配置
  [inputs.promsd.scrape.auth]
    # bearer_token_file = "/path/to/token" # Bearer Token 文件路径

    # insecure_skip_verify = false         # 跳过 TLS 证书验证
    # ca_certs = ["/opt/tls/ca.crt"]       # CA 证书路径
    # cert = "/opt/tls/client.crt"         # 客户端证书
    # cert_key = "/opt/tls/client.key"     # 客户端私钥

关键说明：

协议覆盖：如果 http_sd_config 返回的标签含 __scheme__，将覆盖此处的 scheme 值
TLS 配置：当 scheme = "https" 时生效，自签名证书需指定 ca_certs

HTTP 服务发现配置¶

通过 HTTP 接口动态获取监控目标列表。

[inputs.promsd.http_sd_config]
  ## 服务发现接口 URL
  service_url = "http://<your-http-sd-service>:8080/prometheus/targets"

  ## 目标列表刷新间隔（默认 "3m"）
  refresh_interval = "3m"

  ## 认证配置
  [inputs.promsd.http_sd_config.auth]
    # insecure_skip_verify = false         # 跳过 TLS 证书验证
    # ca_certs = ["/opt/tls/ca.crt"]       # CA 证书路径
    # cert = "/opt/tls/client.crt"         # 客户端证书
    # cert_key = "/opt/tls/client.key"     # 客户端私钥

HTTP 接口规范：

要求	说明
方法	GET
响应格式	JSON 数组，每个对象包含 `targets` 和 `labels`
响应示例	见下方

[
  {
    "targets": ["10.0.0.1:9100", "10.0.0.2:9100"],
    "labels": {
      "env": "prod",
      "app": "node-exporter",
      "__scheme__": "https",
      "__metrics_path__": "/custom/metrics",
      "__param_module": "cpu"
    }
  }
]

targets：监控目标地址列表（IP/Domain + Port）
labels：附加到目标的标签（自动覆盖重复标签）

在 http_sd_config 返回的 JSON 数据中，可通过 labels 字段使用 Prometheus 的特殊双下划线标签覆盖默认配置。这些标签优先级最高，会直接影响抓取行为。

支持的特殊标签列表：

标签	作用	示例值	实际抓取地址，以 `172.16.1.1:9090` 为例
`__metrics_path__`	覆盖默认指标路径（默认是 "/metrics"）	`/custom/metrics`	`http://172.16.1.1:9090/custom/metrics`
`__scheme__`	指定协议（http/https）	`https`	`https://172.16.1.1:9090/metrics`
`__param_<name>`	添加 URL 参数	`__param_module= "cpu"`	`http://172.16.1.1:9090/metrics?module=cpu`

File 服务发现配置¶

通过读取本地存储的 JSON 文件，动态获取监控目标列表。

[[inputs.promsd.file_sd_config]]
  # 用于提取目标组的文件路径模式
  files = ["/path/to/targets/*.json"]

  # 重新读取文件的刷新间隔
  refresh_interval = "5m"

配置项 files 是一个文件路径数组，可以使用通配符 (*) 来匹配多个文件，例如 ["path/to/file.json"] 或 ["/etc/telemetry/targets/*.yaml", "backups/*.json"]。

files 指定的文件内容格式如下：

[
  {
    "targets": ["10.0.0.1:9100", "10.0.0.2:9100"],
    "labels": {
      "env": "prod",
      "app": "node-exporter",
      "__scheme__": "https",
      "__metrics_path__": "/custom/metrics",
      "__param_module": "cpu"
    }
  }
]

targets：监控目标地址列表（IP/Domain + Port）
labels：附加到目标的标签（自动覆盖重复标签）

另外，同样可通过 labels 字段使用 Prometheus 的特殊双下划线标签覆盖默认配置。这些标签优先级最高，会直接影响抓取行为。

支持的特殊标签列表：

标签	作用	示例值	实际抓取地址，以 `172.16.1.1:9090` 为例
`__metrics_path__`	覆盖默认指标路径（默认是 "/metrics"）	`/custom/metrics`	`http://172.16.1.1:9090/custom/metrics`
`__scheme__`	指定协议（http/https）	`https`	`https://172.16.1.1:9090/metrics`
`__param_<name>`	添加 URL 参数	`__param_module= "cpu"`	`http://172.16.1.1:9090/metrics?module=cpu`

Consul 服务发现配置¶

通过 Consul 服务目录动态获取监控目标列表。

[inputs.promsd.consul_sd_config]
  ## Consul 服务器地址（格式：host:port）
  server = "localhost:8500"

  ## API 路径前缀（当 Consul 部署在反向代理后时使用）
  path_prefix = ""

  ## 认证 Token（建议使用环境变量增强安全性）
  token = ""

  ## 指定数据中心（空 = 默认数据中心）
  datacenter = ""

  ## 租户隔离命名空间
  namespace = "default"

  ## 管理分区
  partition = ""

  ## 连接协议（http/https）
  scheme = "http"

  ## 监控的服务列表（空数组 = 所有服务）
  services = [ ]

  ## 原生 Consul 过滤表达式
  ## 示例：'Service.Tags contains "metrics" and Node.Meta.rack == "a1"'
  filter = ""

  ## 允许读取陈旧数据以降低 Consul 集群负载
  allow_stale = true

  ## 目标列表刷新间隔（默认 "5m"）
  refresh_interval = "5m"

  ## 认证配置
  [inputs.promsd.consul_sd_config.auth]
    # insecure_skip_verify = false         # 跳过 TLS 证书验证
    # ca_certs = ["/opt/tls/ca.crt"]       # CA 证书路径
    # cert     = "/opt/tls/client.crt"     # 客户端证书
    # cert_key = "/opt/tls/client.key"     # 客户端私钥

Consul 服务实例处理逻辑¶

目标地址拼接规则
- 根据 inputs.promsd.scrape 基础配置和 Consul 服务实例数据生成采集地址：{scheme}://{host}:{port}{path}?{params}
- scheme/path/params 来自 inputs.promsd.scrape 配置
- host 优先使用 ServiceAddress 字段，为空时使用 Address 字段
- port 始终使用 ServicePort 字段
服务实例示例

[
  {
    "ServiceName": "web-service",
    "ServiceAddress": "192.168.10.10",  // 优先用于 host
    "Address": "172.17.0.4",            // ServiceAddress 为空时回退
    "ServicePort": 8080,                // 始终作为 port
    "ServiceTags": ["prod", "frontend"]
  }
]

最终生成采集地址：http://192.168.10.10:8080/metrics（假设基础配置 path=/metrics）

默认服务风险

务必配置 services 列表，否则会采集 Consul 内置服务（如 consul 服务），导致非预期监控数据。

FAQ¶

Promsd 采集器的会添加哪些 tags？

会添加 3 类 tags，即：

inputs.promsd.tags 采集器配置文件指定的 tags
host 和 instance 这两个访问地址 tags，例如 host="192.168.10.10" 和 instance="192.168.10.10:8080"
DataKit 全局配置的 election_tags