mintel/elasticsearch_exporter repository overview

⁠Elasticsearch Exporter

Prometheus exporter for various metrics about ElasticSearch, written in Go.

⁠Installation

For pre-built binaries please take a look at the releases. https://github.com/justwatchcom/elasticsearch_exporter/releases⁠

⁠Docker

docker pull justwatch/elasticsearch_exporter:1.1.0
docker run --rm -p 9114:9114 justwatch/elasticsearch_exporter:1.1.0

Example docker-compose.yml:

elasticsearch_exporter:
    image: justwatch/elasticsearch_exporter:1.1.0
    command:
     - '--es.uri=http://elasticsearch:9200'
    restart: always
    ports:
    - "127.0.0.1:9114:9114"

⁠Kubernetes

You can find a helm chart in the stable charts repository at https://github.com/kubernetes/charts/tree/master/stable/elasticsearch-exporter⁠.

⁠Configuration

NOTE: The exporter fetches information from an ElasticSearch cluster on every scrape, therefore having a too short scrape interval can impose load on ES master nodes, particularly if you run with --es.all and --es.indices. We suggest you measure how long fetching /_nodes/stats and /_all/_stats takes for your ES cluster to determine whether your scraping interval is too short. As a last resort, you can scrape this exporter using a dedicated job with its own scraping interval.

Below is the command line options summary:

elasticsearch_exporter --help

Commandline parameters start with a single - for versions less than 1.1.0rc1. For versions greater than 1.1.0rc1, commandline parameters are specified with --. Also, all commandline parameters can be provided as environment variables. The environment variable name is derived from the parameter name by replacing . and - with _ and upper-casing the parameter name.

⁠Elasticsearch 7.x security privileges

ES 7.x supports RBACs. The following security privileges are required for the elasticsearch_exporter.

Further Information

• Build in Users⁠
• Defining Roles⁠
• Privileges⁠

⁠Metrics

⁠Alerts & Recording Rules

We provide examples for Prometheus⁠ alerts and recording rules⁠ as well as an Grafana⁠ Dashboard⁠ and a Kubernetes⁠ Deployment⁠.

The example dashboard needs the node_exporter⁠ installed. In order to select the nodes that belong to the ElasticSearch cluster, we rely on a label cluster. Depending on your setup, it can derived from the platform metadata:

For example on GCE⁠

- source_labels: [__meta_gce_metadata_Cluster]
  separator: ;
  regex: (.*)
  target_label: cluster
  replacement: ${1}
  action: replace

Please refer to the Prometheus SD documentation⁠ to see which metadata labels can be used to create the cluster label.

⁠Credit & License

elasticsearch_exporter is maintained by the nice folks from JustWatch⁠ and licensed under the terms of the Apache license.

This package was originally created and maintained by Eric Richardson⁠, who transferred this repository to us in January 2017.

Maintainers of this repository:

• Christoph Oelmüller [email protected]⁠ @zwopir

Please refer to the Git commit log for a complete list of contributors.

⁠Contributing

We welcome any contributions. Please fork the project on GitHub and open Pull Requests for any proposed changes.

Please note that we will not merge any changes that encourage insecure behaviour. If in doubt please open an Issue first to discuss your proposal.