prometheus.exporter.consul
prometheus.exporter.consul
组件集成了 consul_exporter,用于从 consul 安装中收集指标。
用法
prometheus.exporter.consul "LABEL" {
}
参数
以下参数可用于配置导出器的行为。所有参数都是可选的。省略的字段将采用其默认值。
名称 | 类型 | 描述 | 默认值 | required |
---|---|---|---|---|
server | string | 我们需要连接到的 consul 实例的地址(例如,主机和端口)。这可以是本地的 Alloy(例如 localhost:8500),或 consul 服务器的地址。 | https://127.0.0.1:8500 | 否 |
ca_file | string | PEM 编码的证书授权文件路径,用于验证服务器证书的真实性。 | 否 | |
cert_file | string | PEM 编码的证书文件路径,与私钥一起用于验证导出器的真实性。 | 否 | |
key_file | string | PEM 编码的私钥文件路径,与证书一起用于验证导出器的真实性。 | 否 | |
server_name | string | 如果提供,则覆盖 TLS 证书的主机名。它可用于确保证书名称与声明的服务器名称匹配。 | 否 | |
timeout | duration | HTTP 请求到 consul 的超时时间。 | 500ms | 否 |
insecure_skip_verify | bool | 禁用 TLS 主机验证。 | false | 否 |
concurrent_request_limit | string | 限制对 consul 的最大并发请求数量,0 表示无限制。 | 否 | |
allow_stale | bool | 允许任何 Consul 服务器(非领导者)服务读取。 | true | 否 |
require_consistent | bool | 强制读取完全一致。 | 否 | |
kv_prefix | string | 在此前缀下查找 KV 对。 | 否 | |
kv_filter | string | 仅存储匹配此正则表达式模式的键。 | .* | 否 |
generate_health_summary | bool | 收集每个已注册服务的详细信息并导出 consul_catalog_service_node_healthy 。 | true | 否 |
导出字段
以下字段被导出,并且可以被其他组件引用。
名称 | 类型 | 描述 |
---|---|---|
targets | list(map(string)) | 可用于收集导出器指标的目标。 |
例如,可以传递 targets
到一个 discovery.relabel
组件以重新写入目标的标签集,或到一个 prometheus.scrape
组件以收集公开的指标。
组件健康
prometheus.exporter.consul
在配置无效时才报告为不健康。在这些情况下,导出的字段保留其最后的健康值。
调试信息
prometheus.exporter.consul
不公开任何特定组件的调试信息。
调试指标
prometheus.exporter.consul
不公开任何特定组件的调试指标。
示例
此示例使用 prometheus.scrape
组件 从 prometheus.exporter.consul
搜集指标
prometheus.exporter.consul "example" {
server = "https://consul.example.com:8500"
}
// Configure a prometheus.scrape component to collect consul metrics.
prometheus.scrape "demo" {
targets = prometheus.exporter.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
:发送指标到的远程_write兼容服务器的URL。USERNAME
:用于远程_write API认证的用户名。PASSWORD
:用于远程_write API认证的密码。
兼容组件
prometheus.exporter.consul
有可以由以下组件消费的导出内容
- 消费 目标 的组件
注意
连接某些组件可能不合理,或者组件可能需要进一步的配置才能正确工作。请参阅相关文档获取更多信息。