Important: This documentation is about an older version. It's relevant only to the release noted, many of the features and functions have been updated or replaced. Please view the current version.

Documentationbreadcrumb arrow Grafana Alloybreadcrumb arrow Referencebreadcrumb arrow Componentsbreadcrumb arrow prometheusbreadcrumb arrow prometheus.exporter.elasticsearch
General availability (GA) Open source

prometheus.exporter.elasticsearch

The prometheus.exporter.elasticsearch component embeds the 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 documentation for more information.

Usage

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

Arguments

You can use the following arguments with prometheus.exporter.elasticsearch:

NameTypeDescriptionDefaultRequired
addressstringHTTP API address of an Elasticsearch node."http://localhost:9200"no
aliasesboolInclude informational aliases metrics.no
allboolExport stats for all nodes in the cluster. If used, this flag overrides the flag node.no
castringPath to PEM file that contains trusted Certificate Authorities for the Elasticsearch connection.no
client_certstringPath to PEM file that contains the corresponding cert for the private key to connect to Elasticsearch.no
client_private_keystringPath to PEM file that contains the private key for client auth when connecting to Elasticsearch.no
cluster_settingsboolExport stats for cluster settings.no
clusterinfo_intervaldurationCluster info update interval for the cluster label."5m"no
data_streamboolExport stats for Data Streams.no
indices_settingsboolExport stats for settings of all indices of the cluster.no
indicesboolExport stats for indices in the cluster.no
nodestringNode’s name of which metrics should be exposedno
shardsboolExport stats for shards in the cluster (implies indices).no
slmboolExport stats for SLM (Snapshot Lifecycle Management).no
snapshotsboolExport stats for the cluster snapshots.no
ssl_skip_verifyboolSkip SSL verification when connecting to Elasticsearch.no
timeoutdurationTimeout for trying to get stats from Elasticsearch."5s"no

Blocks

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

BlockDescriptionRequired
basic_authConfigure basic_auth for authenticating to the endpoint.no

basic_auth

NameTypeDescriptionDefaultRequired
password_filestringFile containing the basic auth password.no
passwordsecretBasic auth password.no
usernamestringBasic 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.

NameTypeDescription
targetslist(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 address specified by the run command.

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 to collect metrics from prometheus.exporter.elasticsearch:

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:

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.