This is a builtin exporter from Elasticsearch to Prometheus. It collects all relevant metrics and makes them available to Prometheus via the Elasticsearch REST API.
Currently, the available metrics are:
- Cluster status
- Nodes status:
- JVM
- Indices (global)
- Transport
- HTTP
- Scripts
- Process
- Operating System
- File System
- Circuit Breaker
- Indices status
- Cluster settings (selected disk allocation settings only)
- Prometheus HotSpot metrics
- 100% compatible metrics names with upstream.
- 99% of metrics names synced with official documentation.
- Added support OpenMetrics 1.0 format (info, enum, units etc)
- Expose units where applicable.
- Expose indexing pressure metrics.
- Expose adaptive selection metrics.
- Expose discovery metrics.
- Expose JVM cgroups metrics.
- Expose Elasticsearch node version.
- Expand FS metrics with per device metrics
- Get all times in milliseconds to avoid losing sub second precision.
- Fixed
threadpoolmetrics - Add prometheus
client_hotspotmetrics. - Fixed test suite.
- Updated GitHub actions.
- Expose 8.x introduced metrics.
- Expose SLM metrics (default false)
- Expose Snapshot metrics (default false)
- Expose Data streams metrics (default false)
| Elasticsearch | Plugin | Release date |
|---|---|---|
| 8.7.1 | 8.7.1.0 | May 05, 2023 |
| 8.7.0 | 8.7.0.0 | Apr 26, 2023 |
| 8.6.2 | 8.6.2.0 | Feb 17, 2023 |
| 8.6.1 | 8.6.1.0 | Jan 28, 2023 |
| 8.6.0 | 8.6.0.0 | Jan 10, 2023 |
| 8.5.3 | 8.5.3.0 | Dec 09, 2022 |
| 8.5.2 | 8.5.2.0 | Nov 25, 2022 |
| 8.5.1 | 8.5.1.0 | Nov 25, 2022 |
| 8.5.0 | 8.5.0.0 | Nov 19, 2022 |
| 8.4.3 | 8.4.3.1 | Oct 28, 2022 |
| 8.4.3 | 8.4.3.0 | Oct 07, 2022 |
| 8.4.2 | 8.4.2.0 | Sep 23, 2022 |
| 8.4.1 | 8.4.1.0 | Sep 16, 2022 |
| 8.4.0 | 8.4.0.0 | Aug 27, 2022 |
| 8.3.3 | 8.3.3.0 | Jul 30, 2022 |
| 8.3.2 | 8.3.2.0 | Jul 09, 2022 |
| 8.3.1 | 8.3.1.0 | Jul 09, 2022 |
| 8.3.0 | 8.3.0.0 | Jul 09, 2022 |
| 8.2.3 | 8.2.3.0 | Jun 15, 2022 |
| 8.2.2 | 8.2.2.0 | May 28, 2022 |
| 8.2.1 | 8.2.1.0 | May 25, 2022 |
| 8.2.0 | 8.2.0.0 | May 04, 2022 |
| 8.1.3 | 8.1.3.0 | Apr 20, 2022 |
| 8.1.2 | 8.1.2.0 | Mar 31, 2022 |
| 8.1.1 | 8.1.1.0 | Mar 30, 2022 |
| 8.0.1 | 8.0.1.0 | Mar 30, 2022 |
| 8.0.0 | 8.0.0.0 | Mar 30, 2022 |
./bin/elasticsearch-plugin install -b \
https://github.com/mindw/elasticsearch-prometheus-exporter/releases/download/8.7.1.0/prometheus-exporter-8.7.1.0.zip
Do not forget to restart the node after the installation!
Note that the plugin needs the following special permissions:
- java.lang.RuntimePermission accessClassInPackage.com.sun.management
- java.io.FilePermission /proc/self/ read
- java.lang.RuntimePermission accessClassInPackage.sun.misc
- java.lang.RuntimePermission accessDeclaredMembers
- java.lang.reflect.ReflectPermission suppressAccessChecks
If you have a lot of indices and think this data is irrelevant, you can disable in the main configuration file:
prometheus.indices: false
To disable exporting cluster settings use:
prometheus.cluster.settings: false
These settings can be also updated dynamically.
./bin/elasticsearch-plugin remove prometheus-exporter
Do not forget to restart the node after installation!
Metrics are directly available at:
http://<your-elasticsearch-host>:9200/_prometheus/metrics
As a sample result, you get:
# HELP es_process_mem_total_virtual_bytes Memory used by ES process
# TYPE es_process_mem_total_virtual_bytes gauge
es_process_mem_total_virtual_bytes{cluster="develop",node="develop01",} 3.626733568E9
# HELP es_indices_indexing_is_throttled_bool Is indexing throttling ?
# TYPE es_indices_indexing_is_throttled_bool gauge
es_indices_indexing_is_throttled_bool{cluster="develop",node="develop01",} 0.0
# HELP es_jvm_gc_collection_time_seconds Time spent for GC collections
# TYPE es_jvm_gc_collection_time_seconds counter
es_jvm_gc_collection_time_seconds{cluster="develop",node="develop01",gc="old",} 0.0
es_jvm_gc_collection_time_seconds{cluster="develop",node="develop01",gc="young",} 0.0
# HELP es_indices_requestcache_memory_size_bytes Memory used for request cache
# TYPE es_indices_requestcache_memory_size_bytes gauge
es_indices_requestcache_memory_size_bytes{cluster="develop",node="develop01",} 0.0
# HELP es_indices_search_open_contexts_number Number of search open contexts
# TYPE es_indices_search_open_contexts_number gauge
es_indices_search_open_contexts_number{cluster="develop",node="develop01",} 0.0
# HELP es_jvm_mem_nonheap_used_bytes Memory used apart from heap
# TYPE es_jvm_mem_nonheap_used_bytes gauge
es_jvm_mem_nonheap_used_bytes{cluster="develop",node="develop01",} 5.5302736E7
...
On your Prometheus servers, configure a new job as usual.
For example, if you have a cluster of 3 nodes:
- job_name: elasticsearch
scrape_interval: 10s
metrics_path: "/_prometheus/metrics"
static_configs:
- targets:
- node1:9200
- node2:9200
- node3:9200Of course, you could use the service discovery service instead of a static config.
Just keep in mind that metrics_path must be /_prometheus/metrics, otherwise Prometheus will find no metric.
The Maven project site is available at GitHub.
Project contains integration tests implemented using rest layer framework.
To run everything similar to the GitHub Actions pipeline you can do:
docker run -v $(pwd):/home/gradle gradle:7.4.2-jdk17 su gradle -c 'gradle check'
NOTE: Please keep version in sync with .github/workflows/ci.yml
Complete test suite is run using:
gradle clean check
To run individual test file use:
gradle :integTest \
-Dtests.class=org.elasticsearch.rest.PrometheusRestHandlerClientYamlTestSuiteIT \
-Dtests.method="test {yaml=resthandler/20_metrics/Prometheus metrics can be pulled}"
This plugin mainly uses the Prometheus JVM Client.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.