Categorygithub.com/prometheus-community/elasticsearch_exporter
modulepackage
0.3.3
Repository: https://github.com/prometheus-community/elasticsearch_exporter.git
Documentation: pkg.go.dev
Overview
Versions
2
Dependencies
13
Dependents
0
Files
917 SLOC

# README

Elasticsearch Exporter Build Status

Docker Pulls Go Report Card

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

Installation

go get -u github.com/justwatchcom/elasticsearch_exporter

Configuration

elasticsearch_exporter --help
ArgumentDescription
es.uriAddress (host and port) of the Elasticsearch node we should connect to. This could be a local node (localhost:8500, for instance), or the address of a remote Elasticsearch server.
es.allIf true, query stats for all nodes in the cluster, rather than just the node we connect to.
es.timeoutTimeout for trying to get stats from Elasticsearch. (ex: 20s)
es.caPath to PEM file that contains trusted CAs for the Elasticsearch connection.
es.client-private-keyPath to PEM file that contains the private key for client auth when connecting to Elasticsearch.
es.client-certPath to PEM file that contains the corresponding cert for the private key to connect to Elasticsearch.
web.listen-addressAddress to listen on for web interface and telemetry.
web.telemetry-pathPath under which to expose metrics.

NOTE: We support pulling stats for all nodes at once, but in production this is unlikely to be the way you actually want to run the system. It is much better to run an exporter on each Elasticsearch node to remove a single point of failure and improve the connection between operation and reporting.

Elasticsearch 2.0

Parts of the node stats struct changed for Elasticsearch 2.0. For the moment we'll attempt to report important values for both.

  • indices.filter_cache becomes indices.query_cache
  • indices.query_cache becomes indices.request_cache
  • process.cpu lost user and sys time, so we're now reporting total
  • Added process.cpu.max_file_descriptors

Original author

This package was originally created and mainted by Eric Richardson, who transferred this repository to us in Jan 2017.

# Functions

NewExporter returns an initialized Exporter.

# Structs

ClusterHealthResponse is a representation of a Elasticsearch Cluster Health.
Exporter collects Elasticsearch stats from the given server and exports them using the prometheus metrics package.
NodeStatsBreakersResponse is a representation of a statistics about the field data circuit breaker.
No description provided by the author
NodeStatsFSResponse is a representation of a file system information, data path, free disk space, read/write stats.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NodeStatsIndicesResponse is a representation of a indices stats (size, document count, indexing and deletion times, search times, field cache size, merges and flushes).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NodeStatsJVMResponse is a representation of a JVM stats, memory pool information, garbage collection, buffer pools, number of loaded/unloaded classes.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NodeStatsOSResponse is a representation of a operating system stats, load average, mem, swap.
No description provided by the author
No description provided by the author
No description provided by the author
NodeStatsProcessResponse is a representation of a process statistics, memory consumption, cpu usage, open file descriptors.
NodeStatsResponse is a representation of a Elasticsearch Node Stats.
No description provided by the author
NodeStatsThreadPoolPoolResponse is a representation of a statistics about each thread pool, including current size, queue and rejected tasks.
NodeStatsTransportResponse is a representation of a transport statistics about sent and received bytes in cluster communication.
No description provided by the author