发现Hetzner
discovery.hetzner
允许从 Hetzner Cloud API 和 Robot API 获取抓取目标。此服务发现默认使用公网IPv4地址,但可以通过重命名修改。
用法
discovery.hetzner "LABEL" {
role = HETZNER_ROLE
}
参数
以下参数被支持
名称 | 类型 | 描述 | 默认 | 必需 |
---|---|---|---|---|
role | string | 要发现的实体的 Hetzner 角色。 | yes | |
port | int | 从该端口抓取指标的端口。 | 80 | no |
refresh_interval | duration | 服务器刷新的时间。 | "60s" | 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)) | 指定在CONNECT请求期间发送到代理的标头。 | no |
role
必须是robot
或hcloud
之一。
以下之一最多只能提供一项
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_url
或proxy_from_environment
时,才应配置proxy_connect_header
。
块
以下块在discovery.hetzner
定义内部受支持。
层次结构 | 块 | 描述 | 必需 |
---|---|---|---|
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)) | 指定在CONNECT请求期间发送到代理的标头。 | 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_url
或proxy_from_environment
时,才应配置proxy_connect_header
。
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)) | 从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远程写入兼容服务器的URL。USERNAME
:用于远程写入API认证的用户名。PASSWORD
:用于远程写入API认证的密码。
兼容组件
discovery.hetzner
有导出可以被以下组件使用
- 消费目标的组件
注意
连接某些组件可能不合理,或者组件可能需要进一步的配置才能正确连接。有关更多详细信息,请参阅相关文档。