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

# `prometheus.exporter.elasticsearch`

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

> Note
> 
> Currently, Alloy 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 Alloy, and give it only the strictly mandatory security privileges necessary for monitoring your node. Refer to the [Elasticsearch security privileges](https://github.com/prometheus-community/elasticsearch_exporter#elasticsearch-7x-security-privileges) documentation for more information.

## 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 with `prometheus.exporter.elasticsearch`:

Expand table

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

## Blocks

You can use the following block with `prometheus.exporter.elasticsearch`:

No valid configuration blocks found.

### `basic_auth`

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.

> Warning
> 
> Using `password_file` causes the file to be read on every outgoing request. Use the `local.file` component with the `password` attribute instead to avoid unnecessary reads.

## 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](../../../../get-started/component_controller/#in-memory-traffic) address specified by the [run command](../../../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` doesn’t expose any component-specific debug information.

## Debug metrics

`prometheus.exporter.elasticsearch` doesn’t 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.