Elasticsearch extension Extension Updated on Dec 02, 2025 Monitor Elasticsearch clusters, nodes, and indexes, remotely or locally, via API.
Get started Overeview Monitor your Elasticsearch clusters, nodes, and indexes, as well as use the Unified Analysis pages to analyze the health of Elasticsearch clusters and drill down into individual metrics.
Use cases Monitor health and performance of your Elasticsearch cluster using built-in analysis pages and easy-to-navigate dashboards. Benefit from root cause analysis of an Elasticsearch cluster, nodes, and index performance issues. Enable alerts based on detected anomalies. Look for analysis support for Ops, IT, and Network admins. Requirements The Elasticsearch extension uses the following Elasticsearch endpoints to scrape metrics:
/_cluster/health/_all/_stats?level=shards/_nodes/stats/_alias/_cat/shardsAccording to the Elasticsearch documentation , the user defined in the extension monitoring configuration requires the following permissions:
The Elasticsearch extension connects to the Elasticsearch cluster via API. The cluster must be reachable from the ActiveGate where the extension has been activated. A OneAgent-instrumented host can run this extension too, so the Elasticsearch cluster can be monitored from OneAgent by pointing to the localhost network address. However, if you activate this extension on multiple hosts in the same cluster, you receive the same cluster data multiple times. For this reason, activate the extension only on one host in a cluster if you decide to run it locally. The Elasticsearch extension supports:
Elasticsearch version 8.0 or higher. OpenSearch version 2.12.0. However, full compatibility and complete support are not guaranteed. Activation and setup In Dynatrace, download the Elasticsearch extension, and then select Add monitoring configuration next to an extension version under the Versions list. Select the host you want to monitor, and define the URL of the Elasticsearch instance and the credentials to connect to it. Select the feature sets containing the metrics you want to import. Details The Elasticsearch extension is built on the Extensions framework that utilizes a built-in Elasticsearch metric exporter. The Unified Analysis page provide insight into the health and performance of your Elasticsearch clusters.
The Elasticsearch extension package contains:
Data source configuration for metric ingestion. Topology and relationship definitions for Elasticsearch clusters and their nodes, indexes, disks, and thread pools. Unified Analysis pages for every entity (accessible from the dashboard).Overview dashboard. Alerts for several key metrics:
Total CPU Util > 85% Filesystem Usage > 80% Open File Descriptors > 80% of Max File Descriptors Heap Used > 85% Rejected Threads > 300 FAQ What is the DDU consumption of the Elasticsearch extension? The formula for DDU consumption of the extension is as follows:
((12 * number of clusters)
+ (53 * number of nodes)
+ (47 * number of indexes)
+ ( 5 * number of disks)
+ ( 5 * number of thread pools)) * 525.6 DDUs/year
The DDU cost above does not include any possible Log events or Custom events triggered by the extension. For more information, visit DDUs for Log Monitoring Classic and DDUs for custom Davis events .
Feature sets When activating your extension using monitoring configuration , you can limit monitoring to one of the feature sets. To work properly, the extension has to collect at least one metric after the activation.
In highly segmented networks, feature sets can reflect the segments of your environment. Then, when you create a monitoring configuration, you can select a feature set and a corresponding ActiveGate group that can connect to this particular segment.
All metrics that aren't categorized into any feature set are considered to be the default and are always reported.
A metric inherits the feature set of a subgroup, which in turn inherits the feature set of a group. Also, the feature set defined on the metric level overrides the feature set defined on the subgroup level, which in turn overrides the feature set defined on the group level.
index-cache-advanced Query Cache Caches Count elasticsearch_index_stats_query_cache_caches_total.count Amount of caches in the query cache Query Cache Hits elasticsearch_index_stats_query_cache_hits_total Amount of query cache hits Query Cache Misses elasticsearch_index_stats_query_cache_misses_total Amount of query cache misses Query Cache Evictions elasticsearch_index_stats_query_cache_evictions_total Amount of query cache evictions Request Cache Evictions elasticsearch_index_stats_request_cache_evictions_total Amount of request cache evictions Request Cache Hits elasticsearch_index_stats_request_cache_hits_total Amount of request cache hits Request Cache Misses elasticsearch_index_stats_request_cache_misses_total Amount of request cache misses
index-es-overview-basic Alias elasticsearch_indices_aliases The index alias Total Documents elasticsearch_indices_docs_total Total count of documents Documents Without Replicas elasticsearch_indices_docs_primary Total count of documnets without replicas Index Size elasticsearch_indices_store_size_bytes_total Index size in bytes
disk-performance-basic Disk IOPS elasticsearch_filesystem_io_stats_device_operations_count Amount of disk IO operations per second Disk Read Rate elasticsearch_filesystem_io_stats_device_read_operations_count Amount of read operations per second Disk Write Rate elasticsearch_filesystem_io_stats_device_write_operations_count Amount of write operations per second
node-cache-advanced Filter Cache Size elasticsearch_indices_filter_cache_memory_size_bytes Size of the filter cache in bytes Fielddata Memory Usage elasticsearch_indices_fielddata_memory_size_bytes Fielddata memory usage in bytes
host-jvm-advanced Heap Committed Bytes elasticsearch_jvm_memory_committed_bytes Heap committed bytes Garbage Collection Time elasticsearch_jvm_gc_collection_seconds_sum Garbage collection time in seconds Garbage Collection Count elasticsearch_jvm_gc_collection_count.count — Garbage Collection Rate elasticsearch_jvm_gc_collection_rate —
node-es-operations Query Rate elasticsearch_indices_search_query_rate — Fetch Rate elasticsearch_indices_search_fetch_rate — Get Rate elasticsearch_indices_get_rate — Indexing Rate elasticsearch_indices_indexing_index_rate — Refresh Rate elasticsearch_indices_refresh_rate — Flush Rate elasticsearch_indices_flush_rate — Delete Rate elasticsearch_indices_delete_rate — Query Count elasticsearch_indices_search_query_total.count Total query count Query Time elasticsearch_indices_search_query_time_seconds Query time in seconds Fetch Count elasticsearch_indices_search_fetch_total.count Total fetch count Fetch Time elasticsearch_indices_search_fetch_time_seconds Fetch time in seconds Get Count elasticsearch_indices_get_total.count Total get count Get Time elasticsearch_indices_get_time_seconds Get time in seconds Indexing Count elasticsearch_indices_indexing_index_total.count Total indexing count Indexing Time elasticsearch_indices_indexing_index_time_seconds_total Indexing time in seconds Refresh Count elasticsearch_indices_refresh_total.count Total refresh count Refresh Time elasticsearch_indices_refresh_time_seconds_total Refresh time in seconds Flush Count elasticsearch_indices_flush_total.count Total flush count Flush Time elasticsearch_indices_flush_time_seconds Flush time in seconds Delete Count elasticsearch_indices_delete_total.count Total delete count Delete Time elasticsearch_indices_delete_time_seconds Delete time in seconds Merge Count elasticsearch_indices_merges_total.count Total merge count Merge Time elasticsearch_indices_merges_total_time_seconds_total Merge time in seconds Merge Size elasticsearch_indices_merges_total_size_bytes_total Merge size in bytes
host-jvm-basic Heap Max Bytes elasticsearch_jvm_memory_max_bytes Heap max bytes Heap Used Bytes elasticsearch_jvm_memory_used_bytes Heap used bytes Heap Used elasticsearch_jvm_memory_used_percent Heap used percent
thread-pool-basic Threads elasticsearch_thread_pool_threads_count.gauge Count of threads Rejected Threads elasticsearch_thread_pool_rejected_count.gauge Count of rejected threads
disk-performance-advanced Kilobytes Read From Disk elasticsearch_filesystem_io_stats_device_read_size_kilobytes_sum Total kilobytes read from disk Kilobytes Written To Disk elasticsearch_filesystem_io_stats_device_write_size_kilobytes_sum Total kilobytes written to disk
node-circuit-breaker-basic Breaker Limit Size elasticsearch_breakers_limit_size_bytes Circuit Breaker Limit Size Breaker Tripped elasticsearch_breakers_tripped Whether or not a breaker tripped
node-filesystem-basic Filesystem Size elasticsearch_filesystem_data_size_bytes Filesystem size in bytes Filesystem Free elasticsearch_filesystem_data_free_bytes Filesystem available in bytes Filesystem Used elasticsearch_filesystem_data_used_bytes Filesystem Used in bytes Filesystem Usage elasticsearch_filesystem_data_usage_percent Filesystem used percentage
index-es-overview-advanced Total Documents By Shard elasticsearch_indices_shards_docs Total documents by shard Deleted Documents By Shard elasticsearch_indices_shards_docs_deleted Deleted documents by shard Shard Size elasticsearch_indices_shards_store_size_in_bytes Shard size in bytes Deleted Documents elasticsearch_indices_deleted_docs_total Total count of deleted documents Indexing Documents elasticsearch_index_stats_index_current Count of documents that are currently being indexed Merge Stopped Time elasticsearch_index_stats_merge_stopped_time_seconds_total Total large merge stopped time in seconds Merge Throttle Time elasticsearch_index_stats_merge_throttle_time_seconds_total Total merge I/O throttle time in seconds
cluster-health-advanced Initializing Shards elasticsearch_cluster_health_initializing_shards Number of initializing shards Unassigned Shards elasticsearch_cluster_health_unassigned_shards Number of unassigned shards Relocating Shards elasticsearch_cluster_health_relocating_shards Number of relocating shards Delayed Unassigned Shards elasticsearch_cluster_health_delayed_unassigned_shards Number of delayed unassigned shards Data nodes elasticsearch_cluster_health_number_of_data_nodes Number of data nodes
node-network-advanced Network Received bytes elasticsearch_transport_rx_size_bytes_total Amount of bytes received Network sent bytes elasticsearch_transport_tx_size_bytes_total Amount of bytes sent
index-es-operations Scroll Rate elasticsearch_index_stats_search_scroll_rate — Warmer Rate elasticsearch_index_stats_warmer_rate — Search Suggest Rate elasticsearch_index_stats_search_suggest_rate — Total Search Time elasticsearch_index_stats_search_total Total search time in seconds Query Rate elasticsearch_index_stats_search_query_rate — Fetch Rate elasticsearch_index_stats_search_fetch_rate — Get Rate elasticsearch_index_stats_get_rate — Indexing Rate elasticsearch_index_stats_indexing_index_rate — Refresh Rate elasticsearch_index_stats_refresh_rate — Flush Rate elasticsearch_index_stats_flush_rate — Delete Rate elasticsearch_index_stats_indexing_delete_rate — Merge Rate elasticsearch_index_stats_merge_rate — Query Count elasticsearch_index_stats_search_query_total.count Total query count Query Time elasticsearch_index_stats_search_query_time_seconds_total Query time in seconds Fetch Count elasticsearch_index_stats_search_fetch_total.count Total fetch count Fetch Time elasticsearch_index_stats_search_fetch_time_seconds_total Fetch time in seconds Get Count elasticsearch_index_stats_get_total.count Total get count Get Time elasticsearch_index_stats_get_time_seconds_total Get time in seconds Indexing Count elasticsearch_index_stats_indexing_index_total.count Total indexing count Indexing Time elasticsearch_index_stats_indexing_index_time_seconds_total Indexing time in seconds Refresh Count elasticsearch_index_stats_refresh_total.count Total refresh count Refresh Time elasticsearch_index_stats_refresh_time_seconds_total Refresh time in seconds Flush Count elasticsearch_index_stats_flush_total.count Total flush count Flush Time elasticsearch_index_stats_flush_time_seconds_total Flush time in seconds Delete Count elasticsearch_index_stats_indexing_delete_total.count Total delete count Delete Time elasticsearch_index_stats_indexing_delete_time_seconds_total Delete time in seconds Merge Count elasticsearch_index_stats_merge_total.count Total merge count Merge Time elasticsearch_index_stats_merge_time_seconds_total Merge time in seconds Indexing Throttle Time elasticsearch_index_stats_indexing_throttle_time_seconds_total Indexing throttle time in seconds Indexing No-op count elasticsearch_index_stats_indexing_noop_update_total.count Total indexing no-op count Scroll Time elasticsearch_index_stats_search_scroll_time_seconds_total Scroll time in seconds Scroll Count elasticsearch_index_stats_search_scroll_total.count Total scroll count Warmer Count elasticsearch_index_stats_warmer_total.count Total warmer count Warmer Time elasticsearch_index_stats_warmer_time_seconds_total Warmer time in seconds Search Suggest Count elasticsearch_index_stats_search_suggest_total.count Total search suggest count Search Suggest Time elasticsearch_index_stats_search_suggest_time_seconds_total Search suggest time in seconds
node-memory-basic Free Memory elasticsearch_os_mem_free_bytes Free memory in bytes Used Memory elasticsearch_os_mem_used_bytes Used memory in bytes Total Memory elasticsearch_os_mem_total_bytes Total Memory in bytes Memory Usage elasticsearch_os_mem_usage_percent Memory Usage Percent
index-cache-basic Fielddata Evictions elasticsearch_index_stats_fielddata_evictions_total Number of fielddata evictions Fielddata Memory elasticsearch_index_stats_fielddata_memory_bytes_total Amount of fielddata memory in bytes Query Cache Memory elasticsearch_index_stats_query_cache_memory_bytes_total Amount of query cache memory in bytes Query Cache Size elasticsearch_index_stats_query_cache_size Size of the query cache in bytes Request Cache Size elasticsearch_index_stats_request_cache_memory_bytes_total Request cache size in bytes
node-circuit-breaker-advanced Breaker Estimated Size elasticsearch_breakers_estimated_size_bytes Circuit breaker estimated size in bytes Breaker Overhead elasticsearch_breakers_overhead Circuit breaker overhead
node-network-basic Network Received Packets elasticsearch_transport_rx_packets_total.count Amount of packets received Network Sent Packets elasticsearch_transport_tx_packets_total.count Amount of packets sent Network Packets Transferred elasticsearch_transport_transferred_packets_total Count of network packets transferred Network Bytes Transferred elasticsearch_transport_transferred_bytes_total Total network bytes transferred
node-cache-basic Query Cache Size elasticsearch_indices_query_cache_memory_size_bytes Size of the query cache in bytes Request Cache Size elasticsearch_indices_request_cache_memory_size_bytes Size of the request cache in bytes Fielddata Evictions elasticsearch_indices_fielddata_evictions Number of fielddata evictions
thread-pool-advanced Queued Threads elasticsearch_thread_pool_queue_count.gauge Count of queued threads Active Threads elasticsearch_thread_pool_active_count.gauge Count of active threads Completed Threads elasticsearch_thread_pool_completed_count.gauge Count of completed threads
cluster-health-basic Health Status elasticsearch_cluster_health_status Status of cluster health Number of Nodes elasticsearch_cluster_health_number_of_nodes Number of nodes in a cluster Active Replica Shards elasticsearch_cluster_health_replica_shards Number of active replica shards Active Shards elasticsearch_cluster_health_active_shards Number of active shards Active Primary Shards elasticsearch_cluster_health_active_primary_shards Number of active primary shards Pending Tasks elasticsearch_cluster_health_number_of_pending_tasks Number of pending Tasks Max Task Waiting Time elasticsearch_cluster_health_task_max_waiting_in_queue_millis Amount of task waiting time in millis Segments elasticsearch_indices_segment_count_total Number of segments
node-cpu-basic OS CPU Util elasticsearch_os_cpu_percent OS cpu utilization percent Process CPU Util elasticsearch_process_cpu_percent Process cpu utilization percent
node-es-overview Node Roles elasticsearch_nodes_roles Node roles Total Documents elasticsearch_indices_docs Total count of documents Documents Deleted elasticsearch_indices_docs_deleted Total count of deleted documents Shards elasticsearch_node_shards_total Total count of shards Store Throttle Time elasticsearch_indices_store_throttle_time_seconds_total Index store throttle time in seconds Translog Operations elasticsearch_indices_translog_operations Total translog operations Translog Size elasticsearch_indices_translog_size_in_bytes Translog size in bytes
host-fds Max File Descriptors elasticsearch_process_max_files_descriptors Max file descriptors Open File Descriptors elasticsearch_process_open_files_count.gauge Open file descriptors
node-cpu-advanced CPU Load Average(1m) elasticsearch_os_load1 CPU load average over 1 minute CPU Load Average(5m) elasticsearch_os_load5 CPU load average over 5 minutes CPU Load Average(15m) elasticsearch_os_load15 CPU load average over 15 minutes
