文档 Grafana Alloy 参考 组件 discovery discovery.http

HTTP 发现

discovery.http 提供了一种灵活的方式来通过查询外部 http 端点来定义目标。

它从包含零个或多个目标定义的 HTTP 端点获取目标。目标必须以 HTTP 200 响应进行回复。HTTP 标头 Content-Type 必须为 application/json，并且主体必须是有效的 JSON。

示例响应主体

json 复制

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

可以在 JSON 中使用其他字段来将参数传递给 prometheus.scrape，例如 metricsPath 和 scrape_interval。

例如，以下内容将提供一个具有自定义 metricsPath、抓取间隔和超时值的 target

json 复制

[
   {
      "labels" : {
         "__metrics_path__" : "/api/prometheus",
         "__scheme__" : "https",
         "__scrape_interval__" : "60s",
         "__scrape_timeout__" : "10s",
         "service" : "custom-api-service"
      },
      "targets" : [
         "custom-api:443"
      ]
   },
]

还可以使用 __param_<name> 语法将查询参数追加到指标路径。

例如，以下内容将调用指标路径 /health?target_data=prometheus

json 复制

[
   {
      "labels" : {
         "__metrics_path__" : "/health",
         "__scheme__" : "https",
         "__scrape_interval__" : "60s",
         "__scrape_timeout__" : "10s",
         "__param_target_data": "prometheus",
         "service" : "custom-api-service"
      },
      "targets" : [
         "custom-api:443"
      ]
   },
]

有关可以使用的潜在标签的更多信息，请参阅 prometheus.scrape 技术细节 部分或 Prometheus 配置 文档。

用法

alloy 复制

discovery.http "LABEL" {
  url = URL
}

参数

支持以下参数

最多只能提供以下一项

• bearer_token 参数.
• bearer_token_file 参数.
• basic_auth 块.
• authorization 块.
• oauth2 块.

no_proxy 可以包含 IP、CIDR 表示法和域名。IP 和域名可以包含端口号。如果配置了 no_proxy，则必须配置 proxy_url。

proxy_from_environment 使用环境变量 HTTP_PROXY、HTTPS_PROXY 和 NO_PROXY（或其小写版本）。请求使用与它们的方案匹配的环境变量中的代理，除非被 NO_PROXY 排除。如果配置了 proxy_from_environment，则不得配置 proxy_url 和 no_proxy。

仅当配置了 proxy_url 或 proxy_from_environment 时，才应配置 proxy_connect_header。

块

在 discovery.http 的定义中支持以下块

> 符号表示更深的嵌套级别。例如，oauth2 > tls_config 指的是在 oauth2 块内定义的 tls_config 块。

basic_auth 块

password 和 password_file 是互斥的，在 basic_auth 块内只能提供其中一个。

authorization 块

credential 和 credentials_file 是互斥的，在 authorization 块内只能提供其中一个。

oauth2 块

client_secret 和 client_secret_file 是互斥的，在 oauth2 块内只能提供其中一个。

oauth2 块还可以包含一个单独的 tls_config 子块。

no_proxy 可以包含 IP、CIDR 表示法和域名。IP 和域名可以包含端口号。如果配置了 no_proxy，则必须配置 proxy_url。

proxy_from_environment 使用环境变量 HTTP_PROXY、HTTPS_PROXY 和 NO_PROXY（或其小写版本）。请求使用与它们的方案匹配的环境变量中的代理，除非被 NO_PROXY 排除。如果配置了 proxy_from_environment，则不得配置 proxy_url 和 no_proxy。

仅当配置了 proxy_url 或 proxy_from_environment 时，才应配置 proxy_connect_header。

tls_config 块

以下参数对是互斥的，不能同时设置

• ca_pem 和 ca_file
• cert_pem 和 cert_file
• key_pem 和 key_file

配置客户端身份验证时，必须同时提供客户端证书（使用 cert_pem 或 cert_file）和客户端密钥（使用 key_pem 或 key_file）。

当未提供 min_version 时，可接受的最低 TLS 版本将从 Go 的默认最低版本 TLS 1.2 继承。如果提供了 min_version，则必须将其设置为以下字符串之一

• "TLS10"（TLS 1.0）
• "TLS11"（TLS 1.1）
• "TLS12"（TLS 1.2）
• "TLS13"（TLS 1.3）

导出字段

以下字段已导出，可供其他组件引用

每个目标都包含以下标签

• __meta_url：获取目标的 URL。

组件健康状况

仅当 discovery.http 给定无效配置时，才会报告其不健康。在这些情况下，导出字段将保留其上次的健康值。

调试信息

discovery.http 不公开任何特定于组件的调试信息。

调试指标

• prometheus_sd_http_failures_total（计数器）：刷新失败的总数。

示例

此示例将每 15 秒查询一个 URL 并公开它找到的目标

alloy 复制

discovery.http "dynamic_targets" {
  url = "https://example.com/scrape_targets"
  refresh_interval = "15s"
}

兼容组件

discovery.http 具有可被以下组件使用的导出内容

• 使用 目标 的组件