Menu

Caution

Grafana Alloy is the new name for our distribution of the OTel collector. Grafana Agent has been deprecated and is in Long-Term Support (LTS) through October 31, 2025. Grafana Agent will reach an End-of-Life (EOL) on November 1, 2025. Read more about why we recommend migrating to Grafana Alloy.

Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana Agentbreadcrumb arrow Flow modebreadcrumb arrow Referencebreadcrumb arrow Components referencebreadcrumb arrow discovery.uyuni
Open source

discovery.uyuni

discovery.uyuni discovers Uyuni Monitoring Endpoints and exposes them as targets.

Usage

river 
discovery.uyuni "LABEL" {
    server   = SERVER
    username = USERNAME
    password = PASSWORD
}

Arguments

The following arguments are supported:

NameTypeDescriptionDefaultRequired
serverstringThe primary Uyuni Server.yes
usernamestringThe username to use for authentication to the Uyuni API.yes
passwordSecretThe password to use for authentication to the Uyuni API.yes
entitlementstringThe entitlement to filter on when listing targets."monitoring_entitled"no
separatorstringThe separator to use when building the __meta_uyuni_groups label.","no
refresh_intervaldurationInterval at which to refresh the list of targets.1mno
proxy_urlstringHTTP proxy to proxy requests through.no
follow_redirectsboolWhether redirects returned by the server should be followed.trueno
enable_http2boolWhether HTTP2 is supported for requests.trueno

Blocks

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

HierarchyBlockDescriptionRequired
tls_configtls_configTLS configuration for requests to the Uyuni API.no

tls_config block

NameTypeDescriptionDefaultRequired
ca_pemstringCA PEM-encoded text to validate the server with.no
ca_filestringCA certificate to validate the server with.no
cert_pemstringCertificate PEM-encoded text for client authentication.no
cert_filestringCertificate file for client authentication.no
insecure_skip_verifyboolDisables validation of the server certificate.no
key_filestringKey file for client authentication.no
key_pemsecretKey PEM-encoded text for client authentication.no
min_versionstringMinimum acceptable TLS version.no
server_namestringServerName extension to indicate the name of the server.no

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 is not 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:

NameTypeDescription
targetslist(map(string))The set of targets discovered from the Uyuni API.

Each target includes the following labels:

  • __meta_uyuni_minion_hostname: The hostname of the Uyuni Minion.
  • __meta_uyuni_primary_fqdn: The FQDN of the Uyuni primary.
  • __meta_uyuni_system_id: The system ID of the Uyuni Minion.
  • __meta_uyuni_groups: The groups the Uyuni Minion belongs to.
  • __meta_uyuni_endpoint_name: The name of the endpoint.
  • __meta_uyuni_exporter: The name of the exporter.
  • __meta_uyuni_proxy_module: The name of the Uyuni module.
  • __meta_uyuni_metrics_path: The path to the metrics endpoint.
  • __meta_uyuni_scheme: https if TLS is enabled on the endpoint, http otherwise.

These labels are largely derived from a listEndpoints API call to the Uyuni Server.

Component health

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

Debug information

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

Debug metrics

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

Example

river 
discovery.uyuni "example" {
  server    = "https://127.0.0.1/rpc/api"
  username  = UYUNI_USERNAME
  password  = UYUNI_PASSWORD
}

prometheus.scrape "demo" {
  targets    = discovery.uyuni.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:

  • UYUNI_USERNAME: The username to use for authentication to the Uyuni server.
  • UYUNI_PASSWORD: The password to use for authentication to the Uyuni server.
  • 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.