---
title: "discovery.uyuni | Grafana Alloy documentation"
description: "Learn about discovery.uyuni"
---

# `discovery.uyuni`

`discovery.uyuni` discovers [Uyuni](https://www.uyuni-project.org/) Monitoring Endpoints and exposes them as targets.

## Usage

Alloy ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```alloy
discovery.uyuni "<LABEL>" {
    server   = "<SERVER>"
    username = "<USERNAME>"
    password = "<PASSWORD>"
}
```

## Arguments

You can use the following arguments with `discovery.uyuni`:

Expand table

| Name                     | Type                | Description                                                                                      | Default                 | Required |
|--------------------------|---------------------|--------------------------------------------------------------------------------------------------|-------------------------|----------|
| `password`               | `secret`            | The password to use for authentication to the Uyuni API.                                         |                         | yes      |
| `server`                 | `string`            | The primary Uyuni Server.                                                                        |                         | yes      |
| `username`               | `string`            | The username to use for authentication to the Uyuni API.                                         |                         | yes      |
| `enable_http2`           | `bool`              | Whether HTTP2 is supported for requests.                                                         | `true`                  | no       |
| `entitlement`            | `string`            | The entitlement to filter on when listing targets.                                               | `"monitoring_entitled"` | no       |
| `follow_redirects`       | `bool`              | Whether redirects returned by the server should be followed.                                     | `true`                  | no       |
| `http_headers`           | `map(list(secret))` | Custom HTTP headers to be sent along with each request. The map key is the header name.          |                         | no       |
| `no_proxy`               | `string`            | Comma-separated list of IP addresses, CIDR notations, and domain names to exclude from proxying. |                         | no       |
| `proxy_connect_header`   | `map(list(secret))` | Specifies headers to send to proxies during CONNECT requests.                                    |                         | no       |
| `proxy_from_environment` | `bool`              | Use the proxy URL indicated by environment variables.                                            | `false`                 | no       |
| `proxy_url`              | `string`            | HTTP proxy to send requests through.                                                             |                         | no       |
| `refresh_interval`       | `duration`          | Interval at which to refresh the list of targets.                                                | `"1m"`                  | no       |
| `separator`              | `string`            | The separator to use when building the `__meta_uyuni_groups` label.                              | `","`                   | no       |

`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 block with `discovery.uyuni`:

No valid configuration blocks found.

### `tls_config`

The `tls_config` block configures TLS settings for requests to the Uyuni API.

Expand table

| Name                   | Type     | Description                                              | Default | Required |
|------------------------|----------|----------------------------------------------------------|---------|----------|
| `ca_pem`               | `string` | CA PEM-encoded text to validate the server with.         |         | no       |
| `ca_file`              | `string` | CA certificate to validate the server with.              |         | no       |
| `cert_pem`             | `string` | Certificate PEM-encoded text for client authentication.  |         | no       |
| `cert_file`            | `string` | Certificate file for client authentication.              |         | no       |
| `insecure_skip_verify` | `bool`   | Disables validation of the server certificate.           |         | no       |
| `key_file`             | `string` | Key file for client authentication.                      |         | no       |
| `key_pem`              | `secret` | Key PEM-encoded text for client authentication.          |         | no       |
| `min_version`          | `string` | Minimum acceptable TLS version.                          |         | no       |
| `server_name`          | `string` | ServerName 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` 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:

Expand table

| Name      | Type                | Description                                       |
|-----------|---------------------|---------------------------------------------------|
| `targets` | `list(map(string))` | The set of targets discovered from the Uyuni API. |

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](https://www.uyuni-project.org/uyuni-docs-api/uyuni/api/system.monitoring.html) 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

Alloy ![Copy code to clipboard](/media/images/icons/icon-copy-small-2.svg) Copy

```alloy
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.

## Compatible components

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

- Components that consume [Targets](../../../compatibility/#targets-consumers)

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