discovery.hetzner
discovery.hetzner
允许从 Hetzner Cloud API 和 Robot API 中检索抓取目标。默认情况下,此服务发现使用公共 IPv4 地址,但这可以通过重新打标更改。
用法
discovery.hetzner "<LABEL>" {
role = "<HETZNER_ROLE>"
}
参数
您可以将以下参数用于 discovery.hetzner
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
role | string | 要发现的实体的 Hetzner 角色。 | 是 | |
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 header。map key 是 header 名称。 | 否 | |
no_proxy | string | 逗号分隔的 IP 地址、CIDR 表示法和域名列表,用于排除代理。 | 否 | |
port | int | 抓取指标的端口。 | 80 | 否 |
proxy_connect_header | map(list(secret)) | 指定在 CONNECT 请求期间发送给代理的 header。 | 否 | |
proxy_from_environment | bool | 使用环境变量指定的代理 URL。 | false | 否 |
proxy_url | string | 用于发送请求的 HTTP 代理。 | 否 | |
refresh_interval | duration | 刷新服务器的时间间隔。 | "60s" | 否 |
role
必须是 robot
或 hcloud
之一。
最多只能提供以下其中一个
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.hetzner
块 | 描述 | 必需 |
---|---|---|
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 | 包含密钥值的文件。 | 否 | |
credentials | secret | 密钥值。 | 否 | |
type | string | 授权类型,例如“Bearer”。 | 否 |
credential
和 credentials_file
互斥,并且在 authorization
块内只能提供其中一个。
basic_auth
basic_auth
块配置到端点的基本身份验证。
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
password_file | string | 包含 basic auth 密码的文件。 | 否 | |
password | secret | basic auth 密码。 | 否 | |
username | string | basic auth 用户名。 | 否 |
password
和 password_file
互斥,并且在 basic_auth
块内只能提供其中一个。
oauth2
oauth
块配置到端点的 OAuth 2.0 身份验证。
名称 | 类型 | 描述 | 默认值 | 必需 |
---|---|---|---|---|
client_id | string | OAuth2 客户端 ID。 | 否 | |
client_secret_file | string | 包含 OAuth2 客户端密钥的文件。 | 否 | |
client_secret | secret | OAuth2 客户端密钥。 | 否 | |
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 请求期间发送给代理的 header。 | 否 | |
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)) | 从 Hetzner 目录 API 发现的目标集。 |
每个目标包含以下标签
__meta_hetzner_datacenter
: 服务器的数据中心__meta_hetzner_public_ipv4
: 服务器的公共 IPv4 地址。__meta_hetzner_public_ipv6_network
: 服务器的公共 IPv6 网络 (/64)。__meta_hetzner_server_id
: 服务器 ID。__meta_hetzner_server_name
: 服务器名称。__meta_hetzner_server_status
: 服务器状态。
hcloud
以下标签仅适用于 role
设置为 hcloud
的目标
__meta_hetzner_hcloud_cpu_cores
: 服务器的 CPU 核数。__meta_hetzner_hcloud_cpu_type
: 服务器的 CPU 类型(共享或独享)。__meta_hetzner_hcloud_datacenter_location_network_zone
: 服务器的网络区域。__meta_hetzner_hcloud_datacenter_location
: 服务器位置。__meta_hetzner_hcloud_disk_size_gb
: 服务器的磁盘大小(GB)。__meta_hetzner_hcloud_image_description
: 服务器镜像描述。__meta_hetzner_hcloud_image_name
: 服务器镜像名称。__meta_hetzner_hcloud_image_os_flavor
: 服务器镜像的 OS 版本。__meta_hetzner_hcloud_image_os_version
: 服务器镜像的 OS 版本。__meta_hetzner_hcloud_label_<labelname>
: 服务器的每个标签。__meta_hetzner_hcloud_labelpresent_<labelname>
: 对于服务器的每个标签,其值为true
。__meta_hetzner_hcloud_memory_size_gb
: 服务器内存大小(GB)。__meta_hetzner_hcloud_private_ipv4_<networkname>
: 给定网络内服务器的私有 IPv4 地址。__meta_hetzner_hcloud_server_type
: 服务器类型。
robot
以下标签仅适用于 role
设置为 robot
的目标
__meta_hetzner_robot_cancelled
: 服务器取消状态。__meta_hetzner_robot_product
: 服务器产品类型。
组件健康状态
discovery.hetzner
仅在配置无效时报告为不健康。在这种情况下,导出字段会保留其上次健康时的值。
调试信息
discovery.hetzner
不暴露任何组件特定的调试信息。
调试指标
discovery.hetzner
不暴露任何组件特定的调试指标。
示例
此示例从 Hetzner 发现目标
discovery.hetzner "example" {
role = "<HETZNER_ROLE>"
}
prometheus.scrape "demo" {
targets = discovery.hetzner.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>"
}
}
}
替换以下内容
<HETZNER_ROLE>
: 要发现的实体的角色。<PROMETHEUS_REMOTE_WRITE_URL>
: 用于向 Prometheus remote_write 兼容服务器发送指标的 URL。<USERNAME>
: 用于对 remote_write API 进行身份验证的用户名。<PASSWORD>
: 用于对 remote_write API 进行身份验证的密码。
兼容组件
discovery.hetzner
具有可由以下组件使用的导出项
- 使用 Targets 的组件
注意
连接某些组件可能不合理,或者组件可能需要进一步配置才能使连接正常工作。有关更多详细信息,请参阅链接的文档。