discovery.uyuni
discovery.uyuni
discovers Uyuni Monitoring Endpoints and exposes them as targets.
Usage
discovery.uyuni "<LABEL>" {
server = "<SERVER>"
username = "<USERNAME>"
password = "<PASSWORD>"
}
Arguments
You can use the following arguments with discovery.uyuni
:
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
You can use the following blocks with discovery.uyuni
:
tls_config
The tls_config
block configures TLS settings for requests to the Uyuni API.
The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:
ca_pem
andca_file
cert_pem
andcert_file
key_pem
andkey_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_uyuni_endpoint_name
: The name of the endpoint.__meta_uyuni_exporter
: The name of the exporter.__meta_uyuni_groups
: The groups the Uyuni Minion belongs to.__meta_uyuni_metrics_path
: The path to the metrics endpoint.__meta_uyuni_minion_hostname
: The hostname of the Uyuni Minion.__meta_uyuni_primary_fqdn
: The FQDN of the Uyuni primary.__meta_uyuni_proxy_module
: The name of the Uyuni module.__meta_uyuni_scheme
:https
if TLS is enabled on the endpoint,http
otherwise.__meta_uyuni_system_id
: The system ID of the Uyuni Minion.
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
doesn’t expose any component-specific debug information.
Debug metrics
discovery.uyuni
doesn’t expose any component-specific debug metrics.
Example
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 theremote_write
API.<PASSWORD>
: The password to use for authentication to theremote_write
API.
Compatible components
discovery.uyuni
has exports that can be consumed by the following components:
- Components that consume Targets
Note
Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.