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

# prometheus.exporter.elasticsearch

The `prometheus.exporter.elasticsearch` component embeds [elasticsearch\_exporter](https://github.com/prometheus-community/elasticsearch_exporter) for the collection of metrics from ElasticSearch servers.

> Note
> 
> Currently, an Agent can only collect metrics from a single ElasticSearch server. However, the exporter can collect the metrics from all nodes through that server configured.

We strongly recommend that you configure a separate user for the Agent, and give it only the strictly mandatory security privileges necessary for monitoring your node, as per the [official documentation](https://github.com/prometheus-community/elasticsearch_exporter#elasticsearch-7x-security-privileges).

## Usage

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

```alloy
prometheus.exporter.elasticsearch "LABEL" {
    address = "ELASTICSEARCH_ADDRESS"
}
```

## Arguments

You can use the following arguments to configure the exporter’s behavior. Omitted fields take their default values.

Expand table

| Name                   | Type       | Description                                                                                            | Default                   | Required |
|------------------------|------------|--------------------------------------------------------------------------------------------------------|---------------------------|----------|
| `address`              | `string`   | HTTP API address of an Elasticsearch node.                                                             | `"http://localhost:9200"` | no       |
| `timeout`              | `duration` | Timeout for trying to get stats from Elasticsearch.                                                    | `"5s"`                    | no       |
| `all`                  | `bool`     | Export stats for all nodes in the cluster. If used, this flag will override the flag `node`.           |                           | no       |
| `node`                 | `string`   | Node’s name of which metrics should be exposed                                                         |                           | no       |
| `indices`              | bool       | Export stats for indices in the cluster.                                                               |                           | no       |
| `indices_settings`     | bool       | Export stats for settings of all indices of the cluster.                                               |                           | no       |
| `cluster_settings`     | bool       | Export stats for cluster settings.                                                                     |                           | no       |
| `shards`               | bool       | Export stats for shards in the cluster (implies indices).                                              |                           | no       |
| `snapshots`            | bool       | Export stats for the cluster snapshots.                                                                |                           | no       |
| `clusterinfo_interval` | `duration` | Cluster info update interval for the cluster label.                                                    | `"5m"`                    | no       |
| `ca`                   | `string`   | Path to PEM file that contains trusted Certificate Authorities for the Elasticsearch connection.       |                           | no       |
| `client_private_key`   | `string`   | Path to PEM file that contains the private key for client auth when connecting to Elasticsearch.       |                           | no       |
| `client_cert`          | `string`   | Path to PEM file that contains the corresponding cert for the private key to connect to Elasticsearch. |                           | no       |
| `ssl_skip_verify`      | `bool`     | Skip SSL verification when connecting to Elasticsearch.                                                |                           | no       |
| `aliases`              | `bool`     | Include informational aliases metrics.                                                                 |                           | no       |
| `data_streams`         | `bool`     | Export stats for Data Streams.                                                                         |                           | no       |
| `slm`                  | `bool`     | Export stats for SLM (Snapshot Lifecycle Management).                                                  |                           | no       |

## Blocks

The following blocks are supported inside the definition of `prometheus.exporter.elasticsearch`:

Expand table

| Hierarchy   | Block                            | Description                                               | Required |
|-------------|----------------------------------|-----------------------------------------------------------|----------|
| basic\_auth | [basic\_auth](#basic_auth-block) | Configure basic\_auth for authenticating to the endpoint. | no       |

### basic\_auth block

Expand table

| Name            | Type     | Description                              | Default | Required |
|-----------------|----------|------------------------------------------|---------|----------|
| `password_file` | `string` | File containing the basic auth password. |         | no       |
| `password`      | `secret` | Basic auth password.                     |         | no       |
| `username`      | `string` | Basic auth username.                     |         | no       |

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

## 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/v0.43/flow/concepts/component_controller/#in-memory-traffic) address specified by the [run command](/docs/agent/v0.43/flow/reference/cli/run/).

## Component health

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

## Debug information

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

## Debug metrics

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

## Example

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

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

```alloy
prometheus.exporter.elasticsearch "example" {
  address = "http://localhost:9200"
  basic_auth {
    username = USERNAME
    password = PASSWORD
  }
}

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