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

discovery.consulagent

discovery.consulagent 允许您从 Consul 的 Agent API 检索抓取目标。仅监视在同一主机上运行的本地代理注册的服务。这适用于非常大的 Consul 集群，在这些集群中使用 Catalog API 会太慢或资源密集。

用法

alloy 复制

discovery.consulagent "<LABEL>" {
  server = "<CONSUL_SERVER>"
}

参数

您可以将以下参数与 discovery.consulagent 一起使用

块

您可以将以下块与 discovery.consulagent 一起使用

tls_config

tls_config 块配置用于连接到端点的 TLS 设置。

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

• 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_consulagent_address: 目标的地址。
• __meta_consulagent_dc: 目标的数据中心名称。
• __meta_consulagent_health: 服务的健康状态。
• __meta_consulagent_metadata_<key>: 目标的每个节点元数据键值。
• __meta_consulagent_node: 为目标定义的节点名称。
• __meta_consulagent_service_address: 服务的地址。
• __meta_consulagent_service_id: 服务的 ID。
• __meta_consulagent_service_metadata_<key>: 目标的每个服务元数据键值。
• __meta_consulagent_service_port: 服务的端口。
• __meta_consulagent_service: 目标所属的服务的名称。
• __meta_consulagent_tagged_address_<key>: 目标的每个节点标记地址键值。
• __meta_consulagent_tags: 由标签分隔符连接的目标标签列表。

组件健康状况

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

调试信息

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

调试指标

• discovery_consulagent_rpc_duration_seconds (SummaryVec)：Consul Agent RPC 调用的持续时间（秒）。
• discovery_consulagent_rpc_failures_total (Counter)：Consul Agent RPC 调用失败的次数。

示例

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

alloy 复制

discovery.consulagent "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 remote_write 兼容服务器的 URL，用于向其发送指标。
• <USERNAME>: 用于向 remote_write API 进行身份验证的用户名。
• <PASSWORD>: 用于向 remote_write API 进行身份验证的密码。

兼容组件

discovery.consulagent 具有可由以下组件使用的导出

• 使用 目标 的组件