菜单
通用可用性 (GA)

discovery.hetzner

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

用法

alloy
discovery.hetzner "<LABEL>" {
  role = "<HETZNER_ROLE>"
}

参数

您可以将以下参数与 discovery.hetzner 一起使用

名称类型描述默认值必需
rolestring应发现的实体的 Hetzner 角色。
bearer_token_filestring包含用于身份验证的 bearer token 的文件。
bearer_tokensecret用于身份验证的 Bearer token。
enable_http2bool是否支持请求的 HTTP2。true
follow_redirectsbool是否应遵循服务器返回的重定向。true
no_proxystring要从代理中排除的 IP 地址、CIDR 表示法和域名(以逗号分隔的列表)。
portint用于抓取指标的端口。80
proxy_connect_headermap(list(secret))指定在 CONNECT 请求期间发送到代理的标头。
proxy_from_environmentbool使用环境变量指示的代理 URL。false
proxy_urlstring用于发送请求的 HTTP 代理。
refresh_intervalduration服务器刷新的时间间隔。"60s"

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 一起使用

描述必需
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_filestring包含 secret 值的文件。
credentialssecretSecret 值。
typestring授权类型,例如 “Bearer”。

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

basic_auth

basic_auth 块配置到端点的基本身份验证。

名称类型描述默认值必需
password_filestring包含基本身份验证密码的文件。
passwordsecret基本身份验证密码。
usernamestring基本身份验证用户名。

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

oauth2

oauth 块配置到端点的 OAuth 2.0 身份验证。

名称类型描述默认值必需
client_idstringOAuth2 客户端 ID。
client_secret_filestring包含 OAuth2 客户端 secret 的文件。
client_secretsecretOAuth2 客户端 secret。
endpoint_paramsmap(string)要附加到令牌 URL 的可选参数。
proxy_urlstring用于发送请求的 HTTP 代理。
no_proxystring要从代理中排除的 IP 地址、CIDR 表示法和域名(以逗号分隔的列表)。
proxy_from_environmentbool使用环境变量指示的代理 URL。false
proxy_connect_headermap(list(secret))指定在 CONNECT 请求期间发送到代理的标头。
scopeslist(string)要进行身份验证的作用域列表。
token_urlstring从中获取令牌的 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

tls_config 块配置用于连接到端点的 TLS 设置。

名称类型描述默认值必需
ca_pemstring用于验证服务器的 CA PEM 编码文本。
ca_filestring用于验证服务器的 CA 证书。
cert_pemstring用于客户端身份验证的证书 PEM 编码文本。
cert_filestring用于客户端身份验证的证书文件。
insecure_skip_verifybool禁用服务器证书的验证。
key_filestring用于客户端身份验证的密钥文件。
key_pemsecret用于客户端身份验证的密钥 PEM 编码文本。
min_versionstring最低可接受的 TLS 版本。
server_namestringServerName 扩展,用于指示服务器的名称。

以下参数对是互斥的,不能同时设置

  • 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(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 发现目标

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

注意

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