菜单
开源

Hetzner 发现

discovery.hetzner 允许从 Hetzner Cloud APIRobot API 检索抓取目标。此服务发现默认使用公共 IPv4 地址,但可以通过重命名进行更改。

用法

alloy
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_headermap(list(密钥))指定在 CONNECT 请求期间发送到代理的标头。

role 必须是 robothcloud 之一。

最多可以提供以下一项

no_proxy 可以包含 IP、CIDR 表示法和域名。IP 和域名可以包含端口号。如果配置了 no_proxy,则必须配置 proxy_url

proxy_from_environment 使用环境变量 HTTP_PROXY、HTTPS_PROXY 和 NO_PROXY(或其小写版本)。请求使用与它们的方案匹配的环境变量中的代理,除非被 NO_PROXY 排除。如果配置了 proxy_from_environment,则不得配置 proxy_urlno_proxy

仅当配置了 proxy_urlproxy_from_environment 时,才应配置 proxy_connect_header

discovery.hetzner 的定义中支持以下块

层次结构描述必填
basic_authbasic_auth配置用于对端点进行身份验证的 basic_auth。
authorizationauthorization配置对端点的通用授权。
oauth2oauth2配置用于对端点进行身份验证的 OAuth2。
oauth2 > tls_configtls_config配置用于连接到端点的 TLS 设置。
tls_configtls_config配置用于连接到端点的 TLS 设置。

> 符号表示更深的嵌套级别。例如,oauth2 > tls_config 指的是在 oauth2 块内定义的 tls_config 块。

basic_auth 块

名称类型描述默认值必填
password_file字符串包含 basic auth 密码的文件。
password密钥Basic auth 密码。
username字符串Basic auth 用户名。

passwordpassword_file 是互斥的,在 basic_auth 块内只能提供其中一个。

authorization 块

名称类型描述默认值必填
credentials_file字符串包含密钥值的文件。
credentials密钥密钥值。
type字符串授权类型,例如“Bearer”。

credentialcredentials_file 是互斥的,在 authorization 块内只能提供其中一个。

oauth2 块

名称类型描述默认值必填
client_id字符串OAuth2 客户端 ID。
client_secret_file字符串包含 OAuth2 客户端密钥的文件。
client_secret密钥OAuth2 客户端密钥。
endpoint_paramsmap(字符串)要附加到令牌 URL 的可选参数。
proxy_url字符串发送请求的 HTTP 代理。
no_proxy字符串要从代理中排除的 IP 地址、CIDR 表示法和域名列表(以逗号分隔)。
proxy_from_environment布尔值使用环境变量指示的代理 URL。
proxy_connect_headermap(list(密钥))指定在 CONNECT 请求期间发送到代理的标头。
scopeslist(字符串)用于身份验证的范围列表。
token_url字符串从中获取令牌的 URL。

client_secretclient_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_urlno_proxy

仅当配置了 proxy_urlproxy_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_pemca_file
  • cert_pemcert_file
  • key_pemkey_file

配置客户端身份验证时,必须同时提供客户端证书(使用 cert_pemcert_file)和客户端密钥(使用 key_pemkey_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)

导出字段

以下字段已导出,可由其他组件引用

名称类型描述
targetslist(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 发现目标

alloy
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 具有可由以下组件使用的导出

注意

连接某些组件可能不合理,或者组件可能需要进一步配置才能使连接正常工作。有关更多详细信息,请参阅链接的文档。