Skip to content

Update README.md #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open

Update README.md #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
e230246
Update README.md
jjuris Mar 18, 2021
eb35e7a
Add 7.11.2 to match latest elasticsearch version
dmivankov Mar 19, 2021
d0668ec
Merge pull request #305 from cognitedata/7.11.2
vvanholl Mar 20, 2021
c75889a
Release version 7.11.2.0
vvanholl Mar 20, 2021
ffb00d7
Prepare next version
vvanholl Mar 20, 2021
ca69540
Merge branch 'master' into documentation-update
vvanholl Mar 20, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
253 changes: 252 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,263 @@ It collects all relevant metrics and makes them available to Prometheus via the
- Indices status
- Cluster settings (selected [disk allocation settings](https://www.elastic.co/guide/en/elasticsearch/reference/master/disk-allocator.html) only)

## Metrics
|Name|Type|Description|
|--|--|--|
|es_circuitbreaker_estimated_bytes|gauge|Circuit breaker estimated size|
|es_circuitbreaker_limit_bytes|gauge|Circuit breaker size limit|
|es_circuitbreaker_overhead_ratio|gauge|Circuit breaker overhead ratio|
|es_circuitbreaker_tripped_count|gauge|Circuit breaker tripped count|
|es_cluster_datanodes_number|gauge|Number of data nodes in the cluster|
|es_cluster_inflight_fetch_number|gauge|Number of in flight fetches|
|es_cluster_is_timedout_bool|gauge|Is the cluster timed out ?|
|es_cluster_nodes_number|gauge|Number of nodes in the cluster|
|es_cluster_pending_tasks_number|gauge|Number of pending tasks|
|es_cluster_routing_allocation_disk_threshold_enabled|gauge|Disk allocation decider is enabled|
|es_cluster_routing_allocation_disk_watermark_flood_stage_bytes|gauge|Flood stage for disk usage in bytes|
|es_cluster_routing_allocation_disk_watermark_flood_stage_pct|gauge|Flood stage watermark for disk usage in pct|
|es_cluster_routing_allocation_disk_watermark_high_bytes|gauge|High watermark for disk usage in bytes|
|es_cluster_routing_allocation_disk_watermark_high_pct|gauge|High watermark for disk usage in pct|
|es_cluster_routing_allocation_disk_watermark_low_bytes|gauge|Low watermark for disk usage in bytes|
|es_cluster_routing_allocation_disk_watermark_low_pct|gauge|Low watermark for disk usage in pct|
|es_cluster_shards_active_percent|gauge|Percent of active shards|
|es_cluster_shards_number|gauge|Number of shards|
|es_cluster_status|gauge|Cluster status|
|es_cluster_task_max_waiting_time_seconds|gauge|Max waiting time for tasks|
|es_fs_io_total_operations|gauge|Total IO operations|
|es_fs_io_total_read_bytes|gauge|Total IO read bytes|
|es_fs_io_total_read_operations|gauge|Total IO read operations|
|es_fs_io_total_write_bytes|gauge|Total IO write bytes|
|es_fs_io_total_write_operations|gauge|Total IO write operations|
|es_fs_least_usage_free_bytes|gauge|Free disk space for least used mountpoint|
|es_fs_least_usage_total_bytes|gauge|Total disk space for least used mountpoint|
|es_fs_most_usage_free_bytes|gauge|Free disk space for most used mountpoint|
|es_fs_most_usage_total_bytes|gauge|Total disk space for most used mountpoint|
|es_fs_path_available_bytes|gauge|Available disk space|
|es_fs_path_free_bytes|gauge|Free disk space|
|es_fs_path_total_bytes|gauge|Total disk space|
|es_fs_total_available_bytes|gauge|Available disk space for all mount points|
|es_fs_total_free_bytes|gauge|Free disk space for all mountpoints|
|es_fs_total_total_bytes|gauge|Total disk space for all mount points|
|es_http_open_server_number|gauge|Number of open server connections|
|es_http_open_total_count|gauge|Count of opened connections|
|es_index_completion_size_bytes|gauge|Size of completion suggest statistics|
|es_index_doc_deleted_number|gauge|Number of deleted documents|
|es_index_doc_number|gauge|Total number of documents|
|es_index_fielddata_evictions_count|gauge|Count of evictions in field data cache|
|es_index_fielddata_memory_size_bytes|gauge|Memory usage of field date cache|
|es_index_flush_total_count|gauge|Count of flushes|
|es_index_flush_total_time_seconds|gauge|Total time spent while flushes|
|es_index_get_count|gauge|Count of get commands|
|es_index_get_current_number|gauge|Current rate of get commands|
|es_index_get_exists_count|gauge|Count of existing documents when get command|
|es_index_get_exists_time_seconds|gauge|Time spent while existing documents get command|
|es_index_get_missing_count|gauge|Count of missing documents when get command|
|es_index_get_missing_time_seconds|gauge|Time spent while missing documents get command|
|es_index_get_time_seconds|gauge|Time spent while get commands|
|es_index_indexing_delete_count|gauge|Count of documents deleted|
|es_index_indexing_delete_current_number|gauge|Current rate of documents deleted|
|es_index_indexing_delete_time_seconds|gauge|Time spent while deleting documents|
|es_index_indexing_index_count|gauge|Count of documents indexed|
|es_index_indexing_index_current_number|gauge|Current rate of documents indexed|
|es_index_indexing_index_failed_count|gauge|Count of failed to index documents|
|es_index_indexing_index_time_seconds|gauge|Time spent while indexing documents|
|es_index_indexing_is_throttled_bool|gauge|Is indexing throttling ?|
|es_index_indexing_noop_update_count|gauge|Count of noop document updates|
|es_index_indexing_throttle_time_seconds|gauge|Time spent while throttling|
|es_index_merges_current_docs_number|gauge|Current rate of documents merged|
|es_index_merges_current_number|gauge|Current rate of merges|
|es_index_merges_current_size_bytes|gauge|Current rate of bytes merged|
|es_index_merges_total_auto_throttle_bytes|gauge|Bytes merged while throttling|
|es_index_merges_total_docs_count|gauge|Count of documents merged|
|es_index_merges_total_number|gauge|Count of merges|
|es_index_merges_total_size_bytes|gauge|Count of bytes of merged documents|
|es_index_merges_total_stopped_time_seconds|gauge|Time spent while merge process stopped|
|es_index_merges_total_throttled_time_seconds|gauge|Time spent while merging when throttling|
|es_index_merges_total_time_seconds|gauge|Time spent while merging|
|es_index_querycache_cache_count|gauge|Count of queries in cache|
|es_index_querycache_cache_size_bytes|gauge|Query cache size|
|es_index_querycache_evictions_count|gauge|Count of evictions in query cache|
|es_index_querycache_hit_count|gauge|Count of hits in query cache|
|es_index_querycache_memory_size_bytes|gauge|Memory usage of query cache|
|es_index_querycache_miss_number|gauge|Count of misses in query cache|
|es_index_querycache_total_number|gauge|Count of usages of query cache|
|es_index_recovery_current_number|gauge|Current number of recoveries|
|es_index_recovery_throttle_time_seconds|gauge|Time spent while throttling recoveries|
|es_index_refresh_listeners_number|gauge|Number of refresh listeners|
|es_index_refresh_total_count|gauge|Count of refreshes|
|es_index_refresh_total_time_seconds|gauge|Time spent while refreshes|
|es_index_replicas_number|gauge|Number of replicas|
|es_index_requestcache_evictions_count|gauge|Number of evictions in request cache|
|es_index_requestcache_hit_count|gauge|Number of hits in request cache|
|es_index_requestcache_memory_size_bytes|gauge|Memory used for request cache|
|es_index_requestcache_miss_count|gauge|Number of misses in request cache|
|es_index_search_fetch_count|gauge|Count of search fetches|
|es_index_search_fetch_current_number|gauge|Current rate of search fetches|
|es_index_search_fetch_time_seconds|gauge|Time spent while search fetches|
|es_index_search_open_contexts_number|gauge|Number of search open contexts|
|es_index_search_query_count|gauge|Count of search queries|
|es_index_search_query_current_number|gauge|Current rate of search queries|
|es_index_search_query_time_seconds|gauge|Time spent while search queries|
|es_index_search_scroll_count|gauge|Count of search scrolls|
|es_index_search_scroll_current_number|gauge|Current rate of search scrolls|
|es_index_search_scroll_time_seconds|gauge|Time spent while search scrolls|
|es_index_segments_memory_bytes|gauge|Memory used by segments|
|es_index_segments_number|gauge|Current number of segments|
|es_index_shards_number|gauge|Number of shards|
|es_index_status|gauge|Index status|
|es_index_store_size_bytes|gauge|Store size of the indices in bytes|
|es_index_suggest_count|gauge|Count of suggests|
|es_index_suggest_current_number|gauge|Current rate of suggests|
|es_index_suggest_time_seconds|gauge|Time spent while making suggests|
|es_index_translog_operations_number|gauge|Current number of translog operations|
|es_index_translog_size_bytes|gauge|Translog size|
|es_index_translog_uncommitted_operations_number|gauge|Current number of uncommitted translog operations|
|es_index_translog_uncommitted_size_bytes|gauge|Translog uncommitted size|
|es_index_warmer_count|gauge|Counter of warmers|
|es_index_warmer_current_number|gauge|Current number of warmer|
|es_index_warmer_time_seconds|gauge|Time spent during warmers|
|es_indices_completion_size_bytes|gauge|Size of completion suggest statistics|
|es_indices_doc_deleted_number|gauge|Number of deleted documents|
|es_indices_doc_number|gauge|Total number of documents|
|es_indices_fielddata_evictions_count|gauge|Count of evictions in field data cache|
|es_indices_fielddata_memory_size_bytes|gauge|Memory usage of field date cache|
|es_indices_flush_total_count|gauge|Count of flushes|
|es_indices_flush_total_time_seconds|gauge|Total time spent while flushes|
|es_indices_get_count|gauge|Count of get commands|
|es_indices_get_current_number|gauge|Current rate of get commands|
|es_indices_get_exists_count|gauge|Count of existing documents when get command|
|es_indices_get_exists_time_seconds|gauge|Time spent while existing documents get command|
|es_indices_get_missing_count|gauge|Count of missing documents when get command|
|es_indices_get_missing_time_seconds|gauge|Time spent while missing documents get command|
|es_indices_get_time_seconds|gauge|Time spent while get commands|
|es_indices_indexing_delete_count|gauge|Count of documents deleted|
|es_indices_indexing_delete_current_number|gauge|Current rate of documents deleted|
|es_indices_indexing_delete_time_seconds|gauge|Time spent while deleting documents|
|es_indices_indexing_index_count|gauge|Count of documents indexed|
|es_indices_indexing_index_current_number|gauge|Current rate of documents indexed|
|es_indices_indexing_index_failed_count|gauge|Count of failed to index documents|
|es_indices_indexing_index_time_seconds|gauge|Time spent while indexing documents|
|es_indices_indexing_is_throttled_bool|gauge|Is indexing throttling ?|
|es_indices_indexing_noop_update_count|gauge|Count of noop document updates|
|es_indices_indexing_throttle_time_seconds|gauge|Time spent while throttling|
|es_indices_merges_current_docs_number|gauge|Current rate of documents merged|
|es_indices_merges_current_number|gauge|Current rate of merges|
|es_indices_merges_current_size_bytes|gauge|Current rate of bytes merged|
|es_indices_merges_total_auto_throttle_bytes|gauge|Bytes merged while throttling|
|es_indices_merges_total_docs_count|gauge|Count of documents merged|
|es_indices_merges_total_number|gauge|Count of merges|
|es_indices_merges_total_size_bytes|gauge|Count of bytes of merged documents|
|es_indices_merges_total_stopped_time_seconds|gauge|Time spent while merge process stopped|
|es_indices_merges_total_throttled_time_seconds|gauge|Time spent while merging when throttling|
|es_indices_merges_total_time_seconds|gauge|Time spent while merging|
|es_indices_percolate_count|gauge|Count of percolates|
|es_indices_percolate_current_number|gauge|Rate of percolates|
|es_indices_percolate_memory_size_bytes|gauge|Percolate memory size|
|es_indices_percolate_queries_count|gauge|Count of queries percolated|
|es_indices_percolate_time_seconds|gauge|Time spent while percolating|
|es_indices_querycache_cache_count|gauge|Count of queries in cache|
|es_indices_querycache_cache_size_bytes|gauge|Query cache size|
|es_indices_querycache_evictions_count|gauge|Count of evictions in query cache|
|es_indices_querycache_hit_count|gauge|Count of hits in query cache|
|es_indices_querycache_memory_size_bytes|gauge|Memory usage of query cache|
|es_indices_querycache_miss_number|gauge|Count of misses in query cache|
|es_indices_querycache_total_number|gauge|Count of usages of query cache|
|es_indices_recovery_current_number|gauge|Current number of recoveries|
|es_indices_recovery_throttle_time_seconds|gauge|Time spent while throttling recoveries|
|es_indices_refresh_listeners_number|gauge|Number of refresh listeners|
|es_indices_refresh_total_count|gauge|Count of refreshes|
|es_indices_refresh_total_time_seconds|gauge|Time spent while refreshes|
|es_indices_requestcache_evictions_count|gauge|Number of evictions in request cache|
|es_indices_requestcache_hit_count|gauge|Number of hits in request cache|
|es_indices_requestcache_memory_size_bytes|gauge|Memory used for request cache|
|es_indices_requestcache_miss_count|gauge|Number of misses in request cache|
|es_indices_search_fetch_count|gauge|Count of search fetches|
|es_indices_search_fetch_current_number|gauge|Current rate of search fetches|
|es_indices_search_fetch_time_seconds|gauge|Time spent while search fetches|
|es_indices_search_open_contexts_number|gauge|Number of search open contexts|
|es_indices_search_query_count|gauge|Count of search queries|
|es_indices_search_query_current_number|gauge|Current rate of search queries|
|es_indices_search_query_time_seconds|gauge|Time spent while search queries|
|es_indices_search_scroll_count|gauge|Count of search scrolls|
|es_indices_search_scroll_current_number|gauge|Current rate of search scrolls|
|es_indices_search_scroll_time_seconds|gauge|Time spent while search scrolls|
|es_indices_segments_memory_bytes|gauge|Memory used by segments|
|es_indices_segments_number|gauge|Current number of segments|
|es_indices_store_size_bytes|gauge|Store size of the indices in bytes|
|es_indices_suggest_count|gauge|Count of suggests|
|es_indices_suggest_current_number|gauge|Current rate of suggests|
|es_indices_suggest_time_seconds|gauge|Time spent while making suggests|
|es_ingest_pipeline_processor_total_count|gauge|Ingestion total number|
|es_ingest_pipeline_processor_total_current|gauge|Ingestion total current|
|es_ingest_pipeline_processor_total_failed_count|gauge|Ingestion total failed|
|es_ingest_pipeline_processor_total_time_seconds|gauge|Ingestion total time in seconds|
|es_ingest_pipeline_total_count|gauge|Ingestion total number|
|es_ingest_pipeline_total_current|gauge|Ingestion total current|
|es_ingest_pipeline_total_failed_count|gauge|Ingestion total failed|
|es_ingest_pipeline_total_time_seconds|gauge|Ingestion total time in seconds|
|es_ingest_total_count|gauge|Ingestion total number|
|es_ingest_total_current|gauge|Ingestion total current|
|es_ingest_total_failed_count|gauge|Ingestion total failed|
|es_ingest_total_time_seconds|gauge|Ingestion total time in seconds|
|es_jvm_bufferpool_number|gauge|Number of buffer pools|
|es_jvm_bufferpool_total_capacity_bytes|gauge|Total capacity provided by buffer pools|
|es_jvm_bufferpool_used_bytes|gauge|Used memory in buffer pools|
|es_jvm_classes_loaded_number|gauge|Count of loaded classes|
|es_jvm_classes_total_loaded_number|gauge|Total count of loaded classes|
|es_jvm_classes_unloaded_number|gauge|Count of unloaded classes|
|es_jvm_gc_collection_count|gauge|Count of GC collections|
|es_jvm_gc_collection_time_seconds|gauge|Time spent for GC collections|
|es_jvm_mem_heap_committed_bytes|gauge|Committed bytes in heap|
|es_jvm_mem_heap_max_bytes|gauge|Maximum used memory in heap|
|es_jvm_mem_heap_used_bytes|gauge|Memory used in heap|
|es_jvm_mem_heap_used_percent|gauge|Percentage of memory used in heap|
|es_jvm_mem_nonheap_committed_bytes|gauge|Committed bytes apart from heap|
|es_jvm_mem_nonheap_used_bytes|gauge|Memory used apart from heap|
|es_jvm_mem_pool_max_bytes|gauge|Maximum usage of memory pool|
|es_jvm_mem_pool_peak_max_bytes|gauge|Maximum usage peak of memory pool|
|es_jvm_mem_pool_peak_used_bytes|gauge|Used memory peak in memory pool|
|es_jvm_mem_pool_used_bytes|gauge|Used memory in memory pool|
|es_jvm_threads_number|gauge|Number of threads|
|es_jvm_threads_peak_number|gauge|Peak number of threads|
|es_jvm_uptime_seconds|gauge|JVM uptime|
|es_metrics_generate_time_seconds|summary|Time spent while generating metrics|
|es_node_role_bool|gauge|Node role|
|es_os_cpu_percent|gauge|CPU usage in percent|
|es_os_load_average_fifteen_minutes|gauge|CPU load|
|es_os_load_average_five_minutes|gauge|CPU load|
|es_os_load_average_one_minute|gauge|CPU load|
|es_os_mem_free_bytes|gauge|Memory free|
|es_os_mem_free_percent|gauge|Memory free in percent|
|es_os_mem_total_bytes|gauge|Total memory size|
|es_os_mem_used_bytes|gauge|Memory used|
|es_os_mem_used_percent|gauge|Memory used in percent|
|es_os_swap_free_bytes|gauge|Swap free|
|es_os_swap_total_bytes|gauge|Total swap size|
|es_os_swap_used_bytes|gauge|Swap used|
|es_process_cpu_percent|gauge|CPU percentage used by ES process|
|es_process_cpu_time_seconds|gauge|CPU time used by ES process|
|es_process_file_descriptors_max_number|gauge|Max file descriptors|
|es_process_file_descriptors_open_number|gauge|Open file descriptors|
|es_process_mem_total_virtual_bytes|gauge|Memory used by ES process|
|es_script_cache_evictions_count|gauge|Number of evictions in scripts cache|
|es_script_compilations_count|gauge|Number of scripts compilations|
|es_threadpool_tasks_number|gauge|Number of tasks in thread pool|
|es_threadpool_threads_count|gauge|Count of threads in thread pool|
|es_threadpool_threads_number|gauge|Number of threads in thread pool|
|es_transport_rx_bytes_count|gauge|Bytes received|
|es_transport_rx_packets_count|gauge|Received packets|
|es_transport_server_open_number|gauge|Opened server connections|
|es_transport_tx_bytes_count|gauge|Bytes sent|
|es_transport_tx_packets_count|gauge|Sent packets|

## Compatibility matrix

### Version 7.X

| Elasticsearch | Plugin | Release date |
| -------------- | -------------- | ------------ |
| 7.11.2 | 7.11.2.0 | Mar 20, 2021 |
| 7.11.1 | 7.11.1.0 | Feb 22, 2021 |
| 7.10.2 | 7.10.2.0 | Jan 24, 2021 |
| 7.10.1 | 7.10.1.0 | Dec 13, 2020 |
Expand Down Expand Up @@ -60,7 +311,7 @@ It collects all relevant metrics and makes them available to Prometheus via the

## Install

`./bin/elasticsearch-plugin install -b https://github.com/vvanholl/elasticsearch-prometheus-exporter/releases/download/7.11.1.0/prometheus-exporter-7.11.1.0.zip`
`./bin/elasticsearch-plugin install -b https://github.com/vvanholl/elasticsearch-prometheus-exporter/releases/download/7.11.2.0/prometheus-exporter-7.11.2.0.zip`

**Do not forget to restart the node after the installation!**

Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
group = org.elasticsearch.plugin.prometheus

version = 7.11.1.1-SNAPSHOT
version = 7.11.2.1-SNAPSHOT

pluginName = prometheus-exporter
pluginClassname = org.elasticsearch.plugin.prometheus.PrometheusExporterPlugin
Expand Down