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 | 否 |
no_proxy | string | 要从代理中排除的 IP 地址、CIDR 表示法和域名(以逗号分隔的列表)。 | 否 | |
port | int | 用于抓取指标的端口。 | 80 | 否 |
proxy_connect_header | map(list(secret)) | 指定在 CONNECT 请求期间发送到代理的标头。 | 否 | |
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 | 包含 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) | 要附加到令牌 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) | 要进行身份验证的作用域列表。 | 否 | |
token_url | string | 从中获取令牌的 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 的组件
注意
连接某些组件可能不合理,或者组件可能需要进一步配置才能使连接正常工作。有关更多详细信息,请参阅链接的文档。