discovery.marathon
discovery.marathon
允许您从 Marathon 的 Service API 中检索抓取目标。
用法
discovery.marathon "<LABEL>" {
servers = ["<MARATHON_SERVER1>", "<MARATHON_SERVER2>"...]
}
参数
您可以将以下参数与 discovery.marathon
一起使用
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
servers | list(string) | Marathon 服务器列表。 | 是 | |
auth_token_file | string | 包含用于身份验证的 auth token 的文件。 | 否 | |
auth_token | secret | 用于身份验证的 Auth token。 | 否 | |
bearer_token_file | string | 包含用于身份验证的 bearer token 的文件。 | 否 | |
bearer_token | secret | 用于身份验证的 Bearer token。 | 否 | |
enable_http2 | bool | 请求是否支持 HTTP2。 | true | 否 |
follow_redirects | bool | 是否应遵循服务器返回的重定向。 | true | 否 |
http_headers | map(list(secret)) | 每次请求要发送的自定义 HTTP 标头。映射键是标头名称。 | 否 | |
no_proxy | string | 逗号分隔的 IP 地址、CIDR 表示法和域名列表,用于排除代理。 | 否 | |
proxy_connect_header | map(list(secret)) | 指定在 CONNECT 请求期间发送到代理的标头。 | 否 | |
proxy_from_environment | bool | 使用环境变量指示的代理 URL。 | false | 否 |
proxy_url | string | 用于发送请求的 HTTP 代理。 | 否 | |
refresh_interval | duration | 刷新目标列表的间隔。 | "30s" | 否 |
最多可提供以下之一
auth_token_file
参数auth_token
参数authorization
块basic_auth
块bearer_token_file
参数bearer_token
参数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_url
或 proxy_from_environment
时,才应配置 proxy_connect_header
。
块
您可以将以下块与 discovery.marathon
一起使用
块 | 描述 | 必需 |
---|---|---|
authorization | 配置到端点的通用授权。 | 否 |
basic_auth | 配置 basic_auth 以进行到端点的身份验证。 | 否 |
oauth2 | 配置 OAuth 2.0 以进行到端点的身份验证。 | 否 |
oauth2 > tls_config | 配置连接到端点的 TLS 设置。 | 否 |
tls_config | 配置连接到端点的 TLS 设置。 | 否 |
> 符号表示更深的嵌套级别。例如,oauth2
> tls_config
指的是在 oauth2
块内部定义的 tls_config
块。
authorization
authorization
块配置到端点的通用授权。
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
credentials_file | string | 包含 secret 值的文件。 | 否 | |
credentials | secret | Secret 值。 | 否 | |
type | string | 授权类型,例如“Bearer”。 | 否 |
credential
和 credentials_file
是互斥的,在一个 authorization
块内只能提供其中一个。
basic_auth
basic_auth
块配置到端点的基本身份验证。
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
password_file | string | 包含基本身份验证密码的文件。 | 否 | |
password | secret | 基本身份验证密码。 | 否 | |
username | string | 基本身份验证用户名。 | 否 |
password
和 password_file
是互斥的,在一个 basic_auth
块内只能提供其中一个。
oauth2
oauth
块配置到端点的 OAuth 2.0 身份验证。
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
client_id | string | OAuth2 客户端 ID。 | 否 | |
client_secret_file | string | 包含 OAuth2 客户端 secret 的文件。 | 否 | |
client_secret | secret | OAuth2 客户端 secret。 | 否 | |
endpoint_params | map(string) | 可选参数,附加到 token URL。 | 否 | |
proxy_url | string | 用于发送请求的 HTTP 代理。 | 否 | |
no_proxy | string | 逗号分隔的 IP 地址、CIDR 表示法和域名列表,用于排除代理。 | 否 | |
proxy_from_environment | bool | 使用环境变量指示的代理 URL。 | false | 否 |
proxy_connect_header | map(list(secret)) | 指定在 CONNECT 请求期间发送到代理的标头。 | 否 | |
scopes | list(string) | 用于身份验证的 scopes 列表。 | 否 | |
token_url | string | 获取 token 的 URL。 | 否 |
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_url
或 proxy_from_environment
时,才应配置 proxy_connect_header
。
tls_config
tls_config
块配置连接到端点的 TLS 设置。
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
ca_pem | string | CA PEM 编码文本,用于验证服务器。 | 否 | |
ca_file | string | 用于验证服务器的 CA 证书。 | 否 | |
cert_pem | string | 客户端身份验证的证书 PEM 编码文本。 | 否 | |
cert_file | string | 客户端身份验证的证书文件。 | 否 | |
insecure_skip_verify | bool | 禁用服务器证书验证。 | 否 | |
key_file | string | 客户端身份验证的密钥文件。 | 否 | |
key_pem | secret | 客户端身份验证的密钥 PEM 编码文本。 | 否 | |
min_version | string | 最低可接受的 TLS 版本。 | 否 | |
server_name | string | ServerName 扩展,用于指示服务器名称。 | 否 |
以下参数对是互斥的,不能同时设置
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_label_<labelname>
:附加到应用程序的任何 Marathon 标签。__meta_marathon_app
:应用程序名称,斜杠替换为破折号。__meta_marathon_image
:使用的 Docker 镜像名称(如果可用)。__meta_marathon_port_definition_label_<labelname>
:端口定义标签。__meta_marathon_port_index
:端口索引号,例如 PORT1 为 1。__meta_marathon_port_mapping_label_<labelname>
:端口映射标签。__meta_marathon_task
:Apache Mesos 任务的 ID。
组件健康状况
只有在配置无效时,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>
:用于对remote_write
API 进行身份验证的用户名。<PASSWORD>
:用于对remote_write
API 进行身份验证的密码。
兼容组件
discovery.marathon
的导出可供以下组件使用
- 使用 目标 (Targets) 的组件
注意
连接某些组件可能不合理,或者组件可能需要进一步配置才能使连接正常工作。有关更多详细信息,请参阅链接文档。