Documentation Grafana Cloud Instrument and send data Grafana Alloy Reference Components discovery discovery.hetzner

discovery.hetzner

discovery.hetzner allows retrieving scrape targets from Hetzner Cloud API and Robot API. This service discovery uses the public IPv4 address by default, but that can be changed with relabeling.

Usage

alloy Copy

discovery.hetzner "LABEL" {
  role = HETZNER_ROLE
}

Arguments

The following arguments are supported:

role must be one of robot or hcloud.

At most, one of the following can be provided:

• bearer_token argument.
• bearer_token_file argument.
• basic_auth block.
• authorization block.
• oauth2 block.

no_proxy can contain IPs, CIDR notations, and domain names. IP and domain names can contain port numbers. proxy_url must be configured if no_proxy is configured.

proxy_from_environment uses the environment variables HTTP_PROXY, HTTPS_PROXY, and NO_PROXY (or the lowercase versions thereof). Requests use the proxy from the environment variable matching their scheme, unless excluded by NO_PROXY. proxy_url and no_proxy must not be configured if proxy_from_environment is configured.

proxy_connect_header should only be configured if proxy_url or proxy_from_environment are configured.

Blocks

The following blocks are supported inside the definition of discovery.hetzner:

The > symbol indicates deeper levels of nesting. For example, oauth2 > tls_config refers to a tls_config block defined inside an oauth2 block.

basic_auth block

password and password_file are mutually exclusive, and only one can be provided inside a basic_auth block.

authorization block

credential and credentials_file are mutually exclusive, and only one can be provided inside an authorization block.

oauth2 block

client_secret and client_secret_file are mutually exclusive, and only one can be provided inside an oauth2 block.

The oauth2 block may also contain a separate tls_config sub-block.

no_proxy can contain IPs, CIDR notations, and domain names. IP and domain names can contain port numbers. proxy_url must be configured if no_proxy is configured.

proxy_from_environment uses the environment variables HTTP_PROXY, HTTPS_PROXY, and NO_PROXY (or the lowercase versions thereof). Requests use the proxy from the environment variable matching their scheme, unless excluded by NO_PROXY. proxy_url and no_proxy must not be configured if proxy_from_environment is configured.

proxy_connect_header should only be configured if proxy_url or proxy_from_environment are configured.

tls_config block

The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:

• ca_pem and ca_file
• cert_pem and cert_file
• key_pem and key_file

When configuring client authentication, both the client certificate (using cert_pem or cert_file) and the client key (using key_pem or key_file) must be provided.

When min_version isn’t provided, the minimum acceptable TLS version is inherited from Go’s default minimum version, TLS 1.2. If min_version is provided, it must be set to one of the following strings:

• "TLS10" (TLS 1.0)
• "TLS11" (TLS 1.1)
• "TLS12" (TLS 1.2)
• "TLS13" (TLS 1.3)

Exported fields

The following fields are exported and can be referenced by other components:

Each target includes the following labels:

• __meta_hetzner_server_id: the ID of the server
• __meta_hetzner_server_name: the name of the server
• __meta_hetzner_server_status: the status of the server
• __meta_hetzner_public_ipv4: the public ipv4 address of the server
• __meta_hetzner_public_ipv6_network: the public ipv6 network (/64) of the server
• __meta_hetzner_datacenter: the datacenter of the server

hcloud

The labels below are only available for targets with role set to hcloud:

• __meta_hetzner_hcloud_image_name: the image name of the server
• __meta_hetzner_hcloud_image_description: the description of the server image
• __meta_hetzner_hcloud_image_os_flavor: the OS flavor of the server image
• __meta_hetzner_hcloud_image_os_version: the OS version of the server image
• __meta_hetzner_hcloud_datacenter_location: the location of the server
• __meta_hetzner_hcloud_datacenter_location_network_zone: the network zone of the server
• __meta_hetzner_hcloud_server_type: the type of the server
• __meta_hetzner_hcloud_cpu_cores: the CPU cores count of the server
• __meta_hetzner_hcloud_cpu_type: the CPU type of the server (shared or dedicated)
• __meta_hetzner_hcloud_memory_size_gb: the amount of memory of the server (in GB)
• __meta_hetzner_hcloud_disk_size_gb: the disk size of the server (in GB)
• __meta_hetzner_hcloud_private_ipv4_<networkname>: the private ipv4 address of the server within a given network
• __meta_hetzner_hcloud_label_<labelname>: each label of the server
• __meta_hetzner_hcloud_labelpresent_<labelname>: true for each label of the server

robot

The labels below are only available for targets with role set to robot:

• __meta_hetzner_robot_product: the product of the server
• __meta_hetzner_robot_cancelled: the server cancellation status

Component health

discovery.hetzner is only reported as unhealthy when given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

discovery.hetzner does not expose any component-specific debug information.

Debug metrics

discovery.hetzner does not expose any component-specific debug metrics.

Example

This example discovers targets from Hetzner:

alloy Copy

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
    }
  }
}

Replace the following:

• HETZNER_ROLE: The role of the entities that should be discovered.
• PROMETHEUS_REMOTE_WRITE_URL: The URL of the Prometheus remote_write-compatible server to send metrics to.
• USERNAME: The username to use for authentication to the remote_write API.
• PASSWORD: The password to use for authentication to the remote_write API.

Compatible components

discovery.hetzner has exports that can be consumed by the following components:

• Components that consume Targets