发现.nomad
discovery.nomad
允许您从 Nomad 的 Service API 中检索抓取目标。
用法
discovery.nomad "LABEL" {
}
参数
以下参数得到支持
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
server | string | Nomad 服务器的地址。 | https://127.0.0.1:4646 | no |
namespace | string | 要使用的 Nomad 命名空间。 | default | no |
region | string | 要使用的 Nomad 区域。 | global | no |
allow_stale | bool | 允许从非领导者 Nomad 实例读取。 | true | no |
tag_separator | string | Prometheus 标签中连接 Nomad 标签的分隔符。 | , | no |
refresh_interval | duration | 刷新容器列表的频率。 | "30s" | no |
bearer_token_file | string | 包含用于身份验证的托管令牌的文件的文件。 | no | |
bearer_token | secret | 用于身份验证的托管令牌。 | no | |
enable_http2 | bool | 是否支持 HTTP2 请求。 | true | no |
follow_redirects | bool | 是否应跟随服务器返回的重定向。 | true | no |
proxy_url | string | 用作请求的 HTTP 代理。 | no | |
no_proxy | string | 用逗号分隔的 IP 地址、CIDR 表示法和域名列表,排除从中代理。 | no | |
proxy_from_environment | bool | 使用环境变量中指定的代理 URL。 | false | no |
proxy_connect_header | map(list(secret)) | 指定在连接请求期间发送给代理的头。 | no |
以下提供最多一个
no_proxy
可以包含 IP、CIDR 表示法和域名。IP 和域名可以包含端口号。proxy_url
必须配置,如果已经配置了 no_proxy
。
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.nomad
定义中受支持
层次结构 | 区块 | 描述 | 必需 |
---|---|---|---|
basic_auth | basic_auth | 配置 basic_auth 以对端点进行身份验证。 | no |
authorization | authorization | 配置通用的端点授权。 | no |
oauth2 | oauth2 | 配置 OAuth2 以对端点进行身份验证。 | no |
oauth2 > tls_config | tls_config | 配置与端点连接的 TLS 设置。 | no |
tls_config | tls_config | 配置与端点连接的 TLS 设置。 | no |
>
符号表示更深层次的嵌套。例如,oauth2 > tls_config
指的是在 oauth2
块内部定义的 tls_config
块。
basic_auth 区块
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
password_file | string | 包含基本认证密码的文件。 | no | |
password | secret | 基本认证密码。 | no | |
username | string | 基本认证用户名。 | no |
password
和 password_file
是互斥的,并且在 basic_auth
块内只能提供其中一个。
authorization 区块
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
credentials_file | string | 包含密钥值的文件。 | no | |
credentials | secret | 密钥值。 | no | |
type | string | 授权类型,例如,“Bearer”。 | no |
credential
和 credentials_file
是互斥的,并且在 authorization
块内只能提供其中一个。
oauth2 区块
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
client_id | string | OAuth2 客户端 ID。 | no | |
client_secret_file | string | 包含 OAuth2 客户端密钥的文件。 | no | |
client_secret | secret | OAuth2 客户端密钥。 | no | |
endpoint_params | map(string) | 可选参数,用于附加到令牌 URL 上。 | no | |
proxy_url | string | 用作请求的 HTTP 代理。 | no | |
no_proxy | string | 用逗号分隔的 IP 地址、CIDR 表示法和域名列表,排除从中代理。 | no | |
proxy_from_environment | bool | 使用环境变量中指定的代理 URL。 | false | no |
proxy_connect_header | map(list(secret)) | 指定在连接请求期间发送给代理的头。 | no | |
scopes | list(string) | 要授权的权限列表。 | no | |
token_url | string | 获取令牌的 URL。 | no |
client_secret
和 client_secret_file
是互斥的,并且在 oauth2
块内只能提供其中一个。
oauth2
块也可以包含一个单独的 tls_config
子区块。
no_proxy
可以包含 IP、CIDR 表示法和域名。IP 和域名可以包含端口号。proxy_url
必须配置,如果已经配置了 no_proxy
。
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 | string | 用于验证服务器的 CA PEM 编码文本。 | no | |
ca_file | string | 用于验证服务器的 CA 证书。 | no | |
cert_pem | string | 客户端身份验证的证书 PEM 编码文本。 | no | |
cert_file | string | 客户端身份验证的证书文件。 | no | |
insecure_skip_verify | bool | 禁用服务器证书验证。 | no | |
key_file | string | 客户端身份验证的密钥文件。 | no | |
key_pem | secret | 客户端身份验证的密钥 PEM 编码文本。 | no | |
min_version | string | 最小可接受的 TLS 版本。 | no | |
server_name | string | 用于指示服务器名称的 ServerName 扩展。 | no |
以下参数对是互斥的,不能同时设置
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)
导出字段
以下字段是导出的,可以由其他组件引用
名称 | 类型 | 描述 |
---|---|---|
targets | list(map(string)) | 从 Nomad 服务器发现的集合。 |
每个目标包括以下标签
__meta_nomad_address
:目标的服务地址。__meta_nomad_dc
:目标的数据中心名称。__meta_nomad_namespace
:目标的命名空间。__meta_nomad_node_id
:为目标定义的节点名称。__meta_nomad_service
:目标所属服务的名称。__meta_nomad_service_address
:目标的服务的地址。__meta_nomad_service_id
:目标的服务的ID。__meta_nomad_service_port
:目标的服务的端口号。__meta_nomad_tags
:目标标签列表,由标签分隔符连接。
组件健康状态
discovery.nomad
只在给定无效配置时报告为不健康。在这种情况下,导出的字段保留其最后健康值。
调试信息
discovery.nomad
不公开任何组件特定的调试信息。
调试指标
discovery.nomad
不公开任何组件特定的调试指标。
示例
此示例从Nomad服务器发现目标
discovery.nomad "example" {
}
prometheus.scrape "demo" {
targets = discovery.nomad.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
:用于验证远程写入API的用户名。PASSWORD
:用于验证远程写入API的密码。
兼容组件
discovery.nomad
导出可以由以下组件消费
- 消费目标的组件
注意
连接某些组件可能不合理,或者组件可能需要进一步的配置才能正确连接。请参阅链接文档以获取更多信息。