编写 HTTP 服务发现

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

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

基于文件的 SD 与 HTTP SD 的比较

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

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

HTTP SD 端点的要求

如果您实现一个 HTTP SD 端点,需要注意以下几点要求。

响应内容将按原样使用,不做任何修改。在每个刷新间隔(默认为 1 分钟),Prometheus 会向 HTTP SD 端点发送一个 GET 请求。该 GET 请求包含一个 X-Prometheus-Refresh-Interval-Seconds HTTP 标头,其中包含刷新间隔时间。

SD 端点必须返回 HTTP 200 响应,且 HTTP 标头 Content-Typeapplication/json。响应必须是 UTF-8 格式。如果不需要传输任何目标,也必须返回 HTTP 200,并带有一个空列表 []。目标列表是无序的。

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

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

HTTP SD 的 URL 不被视为机密信息。身份验证和任何 API 密钥应通过适当的身份验证机制传递。Prometheus 支持 TLS 身份验证、基本身份验证、OAuth2 和 Authorization 标头。

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"
        }
    }
]

本页内容