Hetzner 发现
discovery.hetzner
允许从 Hetzner Cloud API 和 Robot API 检索抓取目标。此服务发现默认使用公共 IPv4 地址,但可以通过重命名进行更改。
用法
discovery.hetzner "LABEL" {
role = HETZNER_ROLE
}
参数
支持以下参数
名称 | 类型 | 描述 | 默认值 | 必填 |
---|---|---|---|---|
角色 | 字符串 | 应发现的实体的 Hetzner 角色。 | 是 | |
端口 | 整数 | 从中抓取指标的端口。 | 80 | 否 |
刷新间隔 | 持续时间 | 刷新服务器后的时间。 | "60s" | 否 |
bearer_token_file | 字符串 | 包含用于身份验证的 bearer token 的文件。 | 否 | |
bearer_token | 密钥 | 用于身份验证的 Bearer token。 | 否 | |
enable_http2 | 布尔值 | 请求是否支持 HTTP2。 | 是 | 否 |
follow_redirects | 布尔值 | 服务器返回的重定向是否应被跟随。 | 是 | 否 |
proxy_url | 字符串 | 发送请求的 HTTP 代理。 | 否 | |
no_proxy | 字符串 | 要从代理中排除的 IP 地址、CIDR 表示法和域名列表(以逗号分隔)。 | 否 | |
proxy_from_environment | 布尔值 | 使用环境变量指示的代理 URL。 | 否 | 否 |
proxy_connect_header | map(list(密钥)) | 指定在 CONNECT 请求期间发送到代理的标头。 | 否 |
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
的定义中支持以下块
层次结构 | 块 | 描述 | 必填 |
---|---|---|---|
basic_auth | basic_auth | 配置用于对端点进行身份验证的 basic_auth。 | 否 |
authorization | authorization | 配置对端点的通用授权。 | 否 |
oauth2 | oauth2 | 配置用于对端点进行身份验证的 OAuth2。 | 否 |
oauth2 > tls_config | tls_config | 配置用于连接到端点的 TLS 设置。 | 否 |
tls_config | tls_config | 配置用于连接到端点的 TLS 设置。 | 否 |
>
符号表示更深的嵌套级别。例如,oauth2 > tls_config
指的是在 oauth2
块内定义的 tls_config
块。
basic_auth 块
名称 | 类型 | 描述 | 默认值 | 必填 |
---|---|---|---|---|
password_file | 字符串 | 包含 basic auth 密码的文件。 | 否 | |
password | 密钥 | Basic auth 密码。 | 否 | |
username | 字符串 | Basic auth 用户名。 | 否 |
password
和 password_file
是互斥的,在 basic_auth
块内只能提供其中一个。
authorization 块
名称 | 类型 | 描述 | 默认值 | 必填 |
---|---|---|---|---|
credentials_file | 字符串 | 包含密钥值的文件。 | 否 | |
credentials | 密钥 | 密钥值。 | 否 | |
type | 字符串 | 授权类型,例如“Bearer”。 | 否 |
credential
和 credentials_file
是互斥的,在 authorization
块内只能提供其中一个。
oauth2 块
名称 | 类型 | 描述 | 默认值 | 必填 |
---|---|---|---|---|
client_id | 字符串 | OAuth2 客户端 ID。 | 否 | |
client_secret_file | 字符串 | 包含 OAuth2 客户端密钥的文件。 | 否 | |
client_secret | 密钥 | OAuth2 客户端密钥。 | 否 | |
endpoint_params | map(字符串) | 要附加到令牌 URL 的可选参数。 | 否 | |
proxy_url | 字符串 | 发送请求的 HTTP 代理。 | 否 | |
no_proxy | 字符串 | 要从代理中排除的 IP 地址、CIDR 表示法和域名列表(以逗号分隔)。 | 否 | |
proxy_from_environment | 布尔值 | 使用环境变量指示的代理 URL。 | 否 | 否 |
proxy_connect_header | map(list(密钥)) | 指定在 CONNECT 请求期间发送到代理的标头。 | 否 | |
scopes | list(字符串) | 用于身份验证的范围列表。 | 否 | |
token_url | 字符串 | 从中获取令牌的 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 块
名称 | 类型 | 描述 | 默认值 | 必填 |
---|---|---|---|---|
ca_pem | 字符串 | 用于验证服务器的 CA PEM 编码文本。 | 否 | |
ca_file | 字符串 | 用于验证服务器的 CA 证书。 | 否 | |
cert_pem | 字符串 | 用于客户端身份验证的证书 PEM 编码文本。 | 否 | |
cert_file | 字符串 | 用于客户端身份验证的证书文件。 | 否 | |
insecure_skip_verify | 布尔值 | 禁用服务器证书的验证。 | 否 | |
key_file | 字符串 | 用于客户端身份验证的密钥文件。 | 否 | |
key_pem | 密钥 | 用于客户端身份验证的密钥 PEM 编码文本。 | 否 | |
min_version | 字符串 | 可接受的最低 TLS 版本。 | 否 | |
server_name | 字符串 | 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(字符串)) | 从 Hetzner 目录 API 中发现的目标集。 |
每个目标包含以下标签
__meta_hetzner_server_id
:服务器的 ID__meta_hetzner_server_name
:服务器的名称__meta_hetzner_server_status
:服务器的状态__meta_hetzner_public_ipv4
:服务器的公共 ipv4 地址__meta_hetzner_public_ipv6_network
:服务器的公共 ipv6 网络 (/64)__meta_hetzner_datacenter
:服务器的数据中心
hcloud
以下标签仅适用于 role
设置为 hcloud
的目标
__meta_hetzner_hcloud_image_name
:服务器的镜像名称__meta_hetzner_hcloud_image_description
:服务器镜像的描述__meta_hetzner_hcloud_image_os_flavor
:服务器镜像的操作系统风格__meta_hetzner_hcloud_image_os_version
:服务器镜像的操作系统版本__meta_hetzner_hcloud_datacenter_location
:服务器的位置__meta_hetzner_hcloud_datacenter_location_network_zone
:服务器的网络区域__meta_hetzner_hcloud_server_type
:服务器的类型__meta_hetzner_hcloud_cpu_cores
:服务器的 CPU 内核数__meta_hetzner_hcloud_cpu_type
:服务器的 CPU 类型(共享或专用)__meta_hetzner_hcloud_memory_size_gb
:服务器的内存量(以 GB 为单位)__meta_hetzner_hcloud_disk_size_gb
:服务器的磁盘大小(以 GB 为单位)__meta_hetzner_hcloud_private_ipv4_<networkname>
:服务器在给定网络中的私有 ipv4 地址__meta_hetzner_hcloud_label_<labelname>
:服务器的每个标签__meta_hetzner_hcloud_labelpresent_<labelname>
:服务器的每个标签的true
robot
以下标签仅适用于 role
设置为 robot
的目标
__meta_hetzner_robot_product
:服务器的产品__meta_hetzner_robot_cancelled
:服务器取消状态
组件健康状况
仅当给定无效配置时,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
具有可由以下组件使用的导出
- 使用 目标 的组件
注意
连接某些组件可能不合理,或者组件可能需要进一步配置才能使连接正常工作。有关更多详细信息,请参阅链接的文档。