编写 HTTP 服务发现

Prometheus 提供了一种通用的 HTTP 服务发现机制,使其能够通过 HTTP 端点发现目标。

HTTP 服务发现是对现有支持的服务发现机制的补充,也是文件服务发现的一种替代方案。

文件服务发现 (File-Based SD) 与 HTTP 服务发现 (HTTP SD) 的比较

下表比较了我们两种通用的服务发现实现。

项目文件服务发现HTTP 服务发现
基于事件是,通过 inotify
更新频率即时,得益于 inotify遵循 refresh_interval
格式YAML 或 JSONJSON
传输本地文件HTTP/HTTPS
安全性基于文件的安全性TLS、基本认证、Authorization 头、OAuth2

HTTP 服务发现端点要求

如果您实现 HTTP 服务发现端点,这里有一些您应该注意的要求。

响应会原样消费,未经修改。在每个刷新间隔(默认:1 分钟)内,Prometheus 会向 HTTP 服务发现端点发起 GET 请求。GET 请求包含一个 X-Prometheus-Refresh-Interval-Seconds HTTP 头,其中包含刷新间隔。

服务发现端点必须返回 HTTP 200 响应,且 HTTP 头为 Content-Type: application/json。响应必须为 UTF-8 格式。如果没有目标需要传输,也必须返回 HTTP 200,并带有一个空列表 []。目标列表是无序的。

Prometheus 会缓存目标列表。如果在获取更新的目标列表时发生错误,Prometheus 会继续使用当前的目标列表。目标列表不会在重启后保存。prometheus_sd_http_failures_total 计数器指标会跟踪刷新失败的次数。

每次抓取时必须返回完整的目标列表。不支持增量更新。Prometheus 实例不发送其主机名,因此服务发现端点无法知道该服务发现请求是否是重启后的第一次请求。

HTTP 服务发现的 URL 不被视为秘密。身份验证和任何 API 密钥应通过适当的身份验证机制传递。Prometheus 支持 TLS 认证、基本认证、OAuth2 和授权头。

HTTP_SD 格式

[
  {
    "targets": [ "<host>", ... ],
    "labels": {
      "<labelname>": "<labelvalue>", ...
    }
  },
  ...
]

示例

[
    {
        "targets": ["10.0.10.2:9100", "10.0.10.3:9100", "10.0.10.4:9100", "10.0.10.5:9100"],
        "labels": {
            "__meta_datacenter": "london",
            "__meta_prometheus_job": "node"
        }
    },
    {
        "targets": ["10.0.40.2:9100", "10.0.40.3:9100"],
        "labels": {
            "__meta_datacenter": "london",
            "__meta_prometheus_job": "alertmanager"
        }
    },
    {
        "targets": ["10.0.40.2:9093", "10.0.40.3:9093"],
        "labels": {
            "__meta_datacenter": "newyork",
            "__meta_prometheus_job": "alertmanager"
        }
    }
]

本页内容