---
title: "prometheus.exporter.consul | Grafana Agent documentation"
description: "Learn about prometheus.exporter.consul"
---

# prometheus.exporter.consul

The `prometheus.exporter.consul` component embeds [consul\_exporter](https://github.com/prometheus/consul_exporter) for collecting metrics from a consul install.

## Usage

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

```alloy
prometheus.exporter.consul "LABEL" {
}
```

## Arguments

The following arguments can be used to configure the exporter’s behavior. All arguments are optional. Omitted fields take their default values.

Expand table

| Name                       | Type       | Description                                                                                                                                                                 | Default                 | Required |
|----------------------------|------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------|----------|
| `server`                   | `string`   | Address (host and port) of the Consul instance we should connect to. This could be a local Grafana Agent (localhost:8500, for instance), or the address of a Consul server. | `http://localhost:8500` | no       |
| `ca_file`                  | `string`   | File path to a PEM-encoded certificate authority used to validate the authenticity of a server certificate.                                                                 |                         | no       |
| `cert_file`                | `string`   | File path to a PEM-encoded certificate used with the private key to verify the exporter’s authenticity.                                                                     |                         | no       |
| `key_file`                 | `string`   | File path to a PEM-encoded private key used with the certificate to verify the exporter’s authenticity.                                                                     |                         | no       |
| `server_name`              | `string`   | When provided, this overrides the hostname for the TLS certificate. It can be used to ensure that the certificate name matches the hostname we declare.                     |                         | no       |
| `timeout`                  | `duration` | Timeout on HTTP requests to consul.                                                                                                                                         | 500ms                   | no       |
| `insecure_skip_verify`     | `bool`     | Disable TLS host verification.                                                                                                                                              | false                   | no       |
| `concurrent_request_limit` | `string`   | Limit the maximum number of concurrent requests to consul, 0 means no limit.                                                                                                |                         | no       |
| `allow_stale`              | `bool`     | Allows any Consul server (non-leader) to service a read.                                                                                                                    | `true`                  | no       |
| `require_consistent`       | `bool`     | Forces the read to be fully consistent.                                                                                                                                     |                         | no       |
| `kv_prefix`                | `string`   | Prefix under which to look for KV pairs.                                                                                                                                    |                         | no       |
| `kv_filter`                | `string`   | Only store keys that match this regex pattern.                                                                                                                              | `.*`                    | no       |
| `generate_health_summary`  | `bool`     | Collects information about each registered service and exports `consul_catalog_service_node_healthy`.                                                                       | `true`                  | no       |

## Exported fields

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

Expand table

| Name      | Type                | Description                                               |
|-----------|---------------------|-----------------------------------------------------------|
| `targets` | `list(map(string))` | The targets that can be used to collect exporter metrics. |

For example, the `targets` can either be passed to a `discovery.relabel` component to rewrite the targets’ label sets or to a `prometheus.scrape` component that collects the exposed metrics.

The exported targets use the configured [in-memory traffic](/docs/agent/latest/flow/concepts/component_controller/#in-memory-traffic) address specified by the [run command](/docs/agent/latest/flow/reference/cli/run/).

## Component health

`prometheus.exporter.consul` is only reported as unhealthy if given an invalid configuration. In those cases, exported fields retain their last healthy values.

## Debug information

`prometheus.exporter.consul` does not expose any component-specific debug information.

## Debug metrics

`prometheus.exporter.consul` does not expose any component-specific debug metrics.

## Example

This example uses a [`prometheus.scrape` component](../prometheus.scrape/) to collect metrics from `prometheus.exporter.consul`:

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

```alloy
prometheus.exporter.consul "example" {
  server = "https://consul.example.com:8500"
}

// Configure a prometheus.scrape component to collect consul metrics.
prometheus.scrape "demo" {
  targets    = prometheus.exporter.consul.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:

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

`prometheus.exporter.consul` 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.