菜单
正式发布 (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
http_headersmap(list(secret))随每个请求发送的自定义 HTTP header。map key 是 header 名称。
no_proxystring逗号分隔的 IP 地址、CIDR 表示法和域名列表,用于排除代理。
portint抓取指标的端口。80
proxy_connect_headermap(list(secret))指定在 CONNECT 请求期间发送给代理的 header。
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包含密钥值的文件。
credentialssecret密钥值。
typestring授权类型,例如“Bearer”。

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

basic_auth

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

名称类型描述默认值必需
password_filestring包含 basic auth 密码的文件。
passwordsecretbasic auth 密码。
usernamestringbasic auth 用户名。

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

oauth2

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

名称类型描述默认值必需
client_idstringOAuth2 客户端 ID。
client_secret_filestring包含 OAuth2 客户端密钥的文件。
client_secretsecretOAuth2 客户端密钥。
endpoint_paramsmap(string)附加到 token URL 的可选参数。
proxy_urlstring用于发送请求的 HTTP 代理。
no_proxystring逗号分隔的 IP 地址、CIDR 表示法和域名列表,用于排除代理。
proxy_from_environmentbool使用环境变量指定的代理 URL。false
proxy_connect_headermap(list(secret))指定在 CONNECT 请求期间发送给代理的 header。
scopeslist(string)用于身份验证的 scopes 列表。
token_urlstring获取 token 的 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 具有可由以下组件使用的导出项

注意

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