文档 Grafana Alloy 参考 组件 发现 discovery.consul

发现Consul

discovery.consul 允许从 Consul 目录 API 获取抓取目标。

使用方法

alloy 复制

discovery.consul "LABEL" {
  server = CONSUL_SERVER
}

参数

以下参数被支持

最多可提供以下中的一个

• 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_connect_header 应仅在配置了 proxy_url 或 proxy_from_environment 时配置。

块

以下块可以在 discovery.consul 的定义内部使用。

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

基本认证块

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

授权块

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_connect_header 应仅在配置了 proxy_url 或 proxy_from_environment 时配置。

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_consul_address：目标地址。
• __meta_consul_partition：服务注册的行政分区名称。
• __meta_consul_metadata_<key>：目标每个节点元数据键值。
• __meta_consul_node：为目标准定的节点名称。
• __meta_consul_service_address：目标服务地址。
• __meta_consul_service_id：目标服务ID。
• __meta_consul_service_metadata_<key>：目标每个服务元数据键值。
• __meta_consul_service_port：目标服务端口。
• __meta_consul_service：目标所属的服务名称。
• __meta_consul_tagged_address_<key>：目标每个节点标记地址键值。
• __meta_consul_tags：目标标签列表，由标签分隔符连接。

组件健康状态

discovery.consul仅在配置无效时报告为不健康。在这种情况下，导出的字段保留其最后健康的值。

调试信息

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

调试指标

discovery.consul不公开任何特定组件的调试指标。

示例

此示例根据指定的服务列表从Consul发现目标

alloy 复制

discovery.consul "example" {
  server = "localhost:8500"
  services = [
    "service1",
    "service2",
  ]
}

prometheus.scrape "demo" {
  targets    = discovery.consul.example.targets
  forward_to = [prometheus.remote_write.demo.receiver]
}

prometheus.remote_write "demo" {
  endpoint {
    url = <PROMETHEUS_REMOTE_WRITE_URL>

    basic_auth {
      username = <USERNAME>
      password = <PASSWORD>
    }
  }
}

替换以下内容

• <PROMETHEUS_REMOTE_WRITE_URL>：发送指标到的Prometheus远程写入兼容服务器的URL。
• <USERNAME>：用于认证到remote_write API的用户名。
• <PASSWORD>：用于认证到remote_write API的密码。

兼容组件

discovery.consul导出可由以下组件消费的值

• 消费目标的组件