发现.marathon
discovery.marathon
允许您从 Marathon的服务API检索抓取目标。
用法
discovery.marathon "LABEL" {
servers = [MARATHON_SERVER1, MARATHON_SERVER2...]
}
参数
以下参数受到支持
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
servers | list(string) | Marathon服务器的列表。 | yes | |
refresh_interval | duration | 刷新目标列表的间隔。 | "30s" | no |
auth_token | secret | 用于身份验证的认证令牌。 | no | |
auth_token_file | string | 包含用于身份验证的认证令牌的文件。 | 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 |
最多可以提供以下之一
auth_token
参数.auth_token_file
参数.bearer_token_file
参数.bearer_token
参数.basic_auth
块.authorization
块.oauth2
块.
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.marathon
的定义中受支持
层次结构 | 块 | 描述 | 必需 |
---|---|---|---|
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)) | 从 Marathon 服务器发现的靶机集合。 |
每个靶机包括以下标签
__meta_marathon_app
:应用程序的名称(以斜杠替换为破折号)。__meta_marathon_image
:使用的 Docker 映像的名称(如果可用)。__meta_marathon_task
:Mesos 任务的 ID。__meta_marathon_app_label_<labelname>
:附加到应用程序的任何 Marathon 标签。__meta_marathon_port_definition_label_<labelname>
:端口定义标签。__meta_marathon_port_mapping_label_<labelname>
:端口映射标签。__meta_marathon_port_index
:端口索引号(例如,PORT1 的 1)。
组件健康
当给定无效配置时,discovery.marathon
才报告为不健康。在这种情况下,导出字段将保留其最后一个健康值。
调试信息
discovery.marathon
不会公开任何特定于组件的调试信息。
调试指标
discovery.marathon
没有公开任何特定组件的调试指标。
示例
以下示例展示了从 Marathon 服务器发现目标
discovery.marathon "example" {
servers = ["localhost:8500"]
}
prometheus.scrape "demo" {
targets = discovery.marathon.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
:用于远程_write API 认证的用户名。PASSWORD
:用于远程_write API 认证的密码。
兼容组件
discovery.marathon
追踪可以由以下组件使用的导出指标
- 消耗目标数据的组件
注意
连接某些组件可能不合理,或者可能需要进一步配置才能正确连接。请参阅链接文档以获取更多详细信息。