Skip to technology filters Skip to main content
Dynatrace Hub

Extend the platform,
empower your team.

Popular searches:
Home hero bg
ElasticsearchElasticsearch
Elasticsearch

Elasticsearch

Monitor Elasticsearch Clusters, Nodes, Indexes, remotely or locally, via API.

Extension
Free trialDocumentation
Elasticsearch dashboardElasticsearch host KPIsCluster statusCluster nodes and indexesDisks and threads
  • Product information
  • Release notes

Overview

This extension remotely monitors your Elasticsearch Clusters, Nodes, and Indexes metrics, ingesteing metrics minutely. You can use the Unified Analysis screens to analyze Elasticseach clusters' health and drill down into individual metrics to identify the root cause of potential performance issues.

This is intended for users, who:

  • Want to monitor the health and performance of their Elasticsearch Clusters, Nodes, and Indexes.
  • Look for analysis support for Ops, IT and Network Admins.

This enables you to:

  • Monitor your Elasticsearch infrastructure using comprehensive unified analysis screens and dashboards.
  • Enable alerts based on detected anomalies.

Use cases

  • Monitor health and performance of your ElasticSearch cluster, using built-in analysis screens and easy-to-navigate dashboards
  • Root-cause analysis for Elasticsearch cluster, nodes and indexes performance issues.

Get started

  • In Dynatrace, download the Elasticsearch extension and click Add monitoring configuration next to an extension version under the Versions list.
  • Select the host you want to monitor then define the URL to the elasticsearch instance and the credentials to connect to it.
  • Finally select the feature sets containing the metrics you want to import.

Elasticsearch cluster access permissions required

The extension uses following Elasticsearch endpoints to scrape metrics:

  • /_cluster/health
  • /_all/_stats?level=shards
  • /_nodes/stats
  • /_alias
  • /_cat/shards

According to the Elasticsearch documentation, at least the

  • monitor cluster privilege and
  • monitor and view_index_metadata indices privileges

are required for the user defined in the extension monitoring configuration.

Details

The Elasticsearch extension is build on the new Extension 2.0 framework utilizing a built-in Elasticsearch metric exporter. The Unified Analysis screens provide insight into the health and performance of your Elasticsearch clusters.

This 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 screens for every entity (Accessible from the dashboard)
  • An 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

Compatibility information

  • This extension connects to the Elasticsearch cluster via API. The cluster needs to be reachable from the ActiveGate where the extension has been activated.
  • One Agent-instrumented host can run this extension too, so the Elasticsearch cluster can be monitored from OneAgent. pointing at the localhost network address.
    • However, if you activate extension on multiple hosts in the same cluster, you will receive the same cluster data multiple times. So - activate it only on one host in a cluster if you decide to run it locally.
  • This extension supports Elasticsearch version 8.0 or higher.

Q&A

Q: What is the DDU Consumption of this extension?

A: The formula for DDU consumption of the extension is:

 ((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

DDU cost above does not include any possible Log events or Custom events triggered by the extension. For more information on this, please visit the DDU log event cost and DDU custom event cost pages.

Dynatrace
DocumentationMore Information
By Dynatrace
Dynatrace support center
Subscribe to new releases
Copy to clipboard

Extension content

Content typeNumber of items included
screen injections
2
alerts
5
screen layout
5
list screen layout
5
document dashboard
1
screen entities lists
6
metric metadata
151
metric query
29
screen properties
5
screen chart groups
21
dashboards
1
generic type
5
generic relationship
5

Feature sets

Below is a complete list of the feature sets provided in this version. To ensure a good fit for your needs, individual feature sets can be activated and deactivated by your administrator during configuration.

Feature setsNumber of metrics included
Metric nameMetric keyDescriptionUnit
Total Documents By Shardelasticsearch_indices_shards_docsTotal documents by shardCount
Deleted Documents By Shardelasticsearch_indices_shards_docs_deletedDeleted documents by shardCount
Shard Sizeelasticsearch_indices_shards_store_size_in_bytesShard size in bytesByte
Deleted Documentselasticsearch_indices_deleted_docs_totalTotal count of deleted documentsCount
Indexing Documentselasticsearch_index_stats_index_currentCount of documents that are currently being indexedCount
Merge Stopped Timeelasticsearch_index_stats_merge_stopped_time_seconds_totalTotal large merge stopped time in secondsSecond
Merge Throttle Timeelasticsearch_index_stats_merge_throttle_time_seconds_totalTotal merge I/O throttle time in secondsSecond
Metric nameMetric keyDescriptionUnit
Breaker Limit Sizeelasticsearch_breakers_limit_size_bytesCircuit Breaker Limit SizeByte
Breaker Trippedelasticsearch_breakers_trippedWhether or not a breaker trippedState
Metric nameMetric keyDescriptionUnit
Filesystem Sizeelasticsearch_filesystem_data_size_bytesFilesystem size in bytesByte
Filesystem Freeelasticsearch_filesystem_data_free_bytesFilesystem available in bytesByte
Metric nameMetric keyDescriptionUnit
Kilobytes Read From Diskelasticsearch_filesystem_io_stats_device_read_size_kilobytes_sumTotal kilobytes read from diskKiloByte
Kilobytes Written To Diskelasticsearch_filesystem_io_stats_device_write_size_kilobytes_sumTotal kilobytes written to diskKiloByte
Metric nameMetric keyDescriptionUnit
Filter Cache Sizeelasticsearch_indices_filter_cache_memory_size_bytesSize of the filter cache in bytesByte
Fielddata Memory Usageelasticsearch_indices_fielddata_memory_size_bytesFielddata memory usage in bytesByte
Metric nameMetric keyDescriptionUnit
Heap Max Byteselasticsearch_jvm_memory_max_bytesHeap max bytesByte
Heap Used Byteselasticsearch_jvm_memory_used_bytesHeap used bytesByte
Metric nameMetric keyDescriptionUnit
Disk IOPSelasticsearch_filesystem_io_stats_device_operations_countAmount of disk IO operations per secondPerSecond
Disk Read Rateelasticsearch_filesystem_io_stats_device_read_operations_countAmount of read operations per secondPerSecond
Disk Write Rateelasticsearch_filesystem_io_stats_device_write_operations_countAmount of write operations per secondPerSecond
Metric nameMetric keyDescriptionUnit
Heap Committed Byteselasticsearch_jvm_memory_committed_bytesHeap committed bytesByte
Garbage Collection Timeelasticsearch_jvm_gc_collection_seconds_sumGarbage collection time in secondsSecond
Garbage Collection Countelasticsearch_jvm_gc_collection_count.count-Count
Metric nameMetric keyDescriptionUnit
Query Countelasticsearch_indices_search_query_total.countTotal query countCount
Query Timeelasticsearch_indices_search_query_time_secondsQuery time in secondsSecond
Fetch Countelasticsearch_indices_search_fetch_total.countTotal fetch countCount
Fetch Timeelasticsearch_indices_search_fetch_time_secondsFetch time in secondsSecond
Get Countelasticsearch_indices_get_total.countTotal get countCount
Get Timeelasticsearch_indices_get_time_secondsGet time in secondsSecond
Indexing Countelasticsearch_indices_indexing_index_total.countTotal indexing countCount
Indexing Timeelasticsearch_indices_indexing_index_time_seconds_totalIndexing time in secondsSecond
Refresh Countelasticsearch_indices_refresh_total.countTotal refresh countCount
Refresh Timeelasticsearch_indices_refresh_time_seconds_totalRefresh time in secondsSecond
Flush Countelasticsearch_indices_flush_total.countTotal flush countCount
Flush Timeelasticsearch_indices_flush_time_secondsFlush time in secondsSecond
Delete Countelasticsearch_indices_delete_total.countTotal delete countCount
Delete Timeelasticsearch_indices_delete_time_secondsDelete time in secondsSecond
Merge Countelasticsearch_indices_merges_total.countTotal merge countCount
Merge Timeelasticsearch_indices_merges_total_time_seconds_totalMerge time in secondsSecond
Merge Sizeelasticsearch_indices_merges_total_size_bytes_totalMerge size in bytesByte
Metric nameMetric keyDescriptionUnit
Threadselasticsearch_thread_pool_threads_count.gaugeCount of threadsCount
Rejected Threadselasticsearch_thread_pool_rejected_count.gaugeCount of rejected threadsCount
Metric nameMetric keyDescriptionUnit
Aliaselasticsearch_indices_aliasesThe index aliasUnspecified
Total Documentselasticsearch_indices_docs_totalTotal count of documentsCount
Documents Without Replicaselasticsearch_indices_docs_primaryTotal count of documnets without replicasCount
Index Sizeelasticsearch_indices_store_size_bytes_totalIndex size in bytesByte
Metric nameMetric keyDescriptionUnit
Query Cache Caches Countelasticsearch_index_stats_query_cache_caches_total.countAmount of caches in the query cacheCount
Query Cache Hitselasticsearch_index_stats_query_cache_hits_totalAmount of query cache hitsCount
Query Cache Misseselasticsearch_index_stats_query_cache_misses_totalAmount of query cache missesCount
Query Cache Evictionselasticsearch_index_stats_query_cache_evictions_totalAmount of query cache evictionsCount
Request Cache Evictionselasticsearch_index_stats_request_cache_evictions_totalAmount of request cache evictionsCount
Request Cache Hitselasticsearch_index_stats_request_cache_hits_totalAmount of request cache hitsCount
Request Cache Misseselasticsearch_index_stats_request_cache_misses_totalAmount of request cache missesCount
Metric nameMetric keyDescriptionUnit
CPU Load Average(1m)elasticsearch_os_load1CPU load average over 1 minuteCount
CPU Load Average(5m)elasticsearch_os_load5CPU load average over 5 minutesCount
CPU Load Average(15m)elasticsearch_os_load15CPU load average over 15 minutesCount
Metric nameMetric keyDescriptionUnit
Max File Descriptorselasticsearch_process_max_files_descriptorsMax file descriptorsCount
Open File Descriptorselasticsearch_process_open_files_count.gaugeOpen file descriptorsCount
Metric nameMetric keyDescriptionUnit
Node Roleselasticsearch_nodes_rolesNode rolesCount
Total Documentselasticsearch_indices_docsTotal count of documentsCount
Documents Deletedelasticsearch_indices_docs_deletedTotal count of deleted documentsCount
Shardselasticsearch_node_shards_totalTotal count of shardsCount
Store Throttle Timeelasticsearch_indices_store_throttle_time_seconds_totalIndex store throttle time in secondsSecond
Translog Operationselasticsearch_indices_translog_operationsTotal translog operationsCount
Translog Sizeelasticsearch_indices_translog_size_in_bytesTranslog size in bytesByte
Metric nameMetric keyDescriptionUnit
OS CPU Utilelasticsearch_os_cpu_percentOS cpu utilization percentPercent
Process CPU Utilelasticsearch_process_cpu_percentProcess cpu utilization percentPercent
Metric nameMetric keyDescriptionUnit
Queued Threadselasticsearch_thread_pool_queue_count.gaugeCount of queued threadsCount
Active Threadselasticsearch_thread_pool_active_count.gaugeCount of active threadsCount
Completed Threadselasticsearch_thread_pool_completed_count.gaugeCount of completed threadsCount
Metric nameMetric keyDescriptionUnit
Health Statuselasticsearch_cluster_health_statusStatus of cluster healthUnspecified
Number of Nodeselasticsearch_cluster_health_number_of_nodesNumber of nodes in a clusterCount
Active Shardselasticsearch_cluster_health_active_shardsNumber of active shardsCount
Active Primary Shardselasticsearch_cluster_health_active_primary_shardsNumber of active primary shardsCount
Pending Taskselasticsearch_cluster_health_number_of_pending_tasksNumber of pending TasksCount
Max Task Waiting Timeelasticsearch_cluster_health_task_max_waiting_in_queue_millisAmount of task waiting time in millisMilliSecond
Segmentselasticsearch_indices_segment_count_totalNumber of segmentsCount
Metric nameMetric keyDescriptionUnit
Network Received Packetselasticsearch_transport_rx_packets_total.countAmount of packets receivedCount
Network Sent Packetselasticsearch_transport_tx_packets_total.countAmount of packets sentCount
Metric nameMetric keyDescriptionUnit
Query Cache Sizeelasticsearch_indices_query_cache_memory_size_bytesSize of the query cache in bytesCount
Request Cache Sizeelasticsearch_indices_request_cache_memory_size_bytesSize of the request cache in bytesByte
Fielddata Evictionselasticsearch_indices_fielddata_evictionsNumber of fielddata evictionsCount
Metric nameMetric keyDescriptionUnit
Breaker Estimated Sizeelasticsearch_breakers_estimated_size_bytesCircuit breaker estimated size in bytesByte
Breaker Overheadelasticsearch_breakers_overheadCircuit breaker overheadCount
Metric nameMetric keyDescriptionUnit
Network Received byteselasticsearch_transport_rx_size_bytes_totalAmount of bytes receivedByte
Network sent byteselasticsearch_transport_tx_size_bytes_totalAmount of bytes sentByte
Metric nameMetric keyDescriptionUnit
Query Countelasticsearch_index_stats_search_query_total.countTotal query countCount
Query Timeelasticsearch_index_stats_search_query_time_seconds_totalQuery time in secondsSecond
Fetch Countelasticsearch_index_stats_search_fetch_total.countTotal fetch countCount
Fetch Timeelasticsearch_index_stats_search_fetch_time_seconds_totalFetch time in secondsSecond
Get Countelasticsearch_index_stats_get_total.countTotal get countCount
Get Timeelasticsearch_index_stats_get_time_seconds_totalGet time in secondsSecond
Indexing Countelasticsearch_index_stats_indexing_index_total.countTotal indexing countCount
Indexing Timeelasticsearch_index_stats_indexing_index_time_seconds_totalIndexing time in secondsSecond
Refresh Countelasticsearch_index_stats_refresh_total.countTotal refresh countCount
Refresh Timeelasticsearch_index_stats_refresh_time_seconds_totalRefresh time in secondsSecond
Flush Countelasticsearch_index_stats_flush_total.countTotal flush countCount
Flush Timeelasticsearch_index_stats_flush_time_seconds_totalFlush time in secondsSecond
Delete Countelasticsearch_index_stats_indexing_delete_total.countTotal delete countCount
Delete Timeelasticsearch_index_stats_indexing_delete_time_seconds_totalDelete time in secondsSecond
Merge Countelasticsearch_index_stats_merge_total.countTotal merge countCount
Merge Timeelasticsearch_index_stats_merge_time_seconds_totalMerge time in secondsSecond
Indexing Throttle Timeelasticsearch_index_stats_indexing_throttle_time_seconds_totalIndexing throttle time in secondsSecond
Indexing No-op countelasticsearch_index_stats_indexing_noop_update_total.countTotal indexing no-op countCount
Scroll Timeelasticsearch_index_stats_search_scroll_time_seconds_totalScroll time in secondsSecond
Scroll Countelasticsearch_index_stats_search_scroll_total.countTotal scroll countCount
Warmer Countelasticsearch_index_stats_warmer_total.countTotal warmer countCount
Warmer Timeelasticsearch_index_stats_warmer_time_seconds_totalWarmer time in secondsSecond
Search Suggest Countelasticsearch_index_stats_search_suggest_total.countTotal search suggest countCount
Search Suggest Timeelasticsearch_index_stats_search_suggest_time_seconds_totalSearch suggest time in secondsSecond
Metric nameMetric keyDescriptionUnit
Free Memoryelasticsearch_os_mem_free_bytesFree memory in bytesByte
Used Memoryelasticsearch_os_mem_used_bytesUsed memory in bytesByte
Metric nameMetric keyDescriptionUnit
Fielddata Evictionselasticsearch_index_stats_fielddata_evictions_totalNumber of fielddata evictionsCount
Fielddata Memoryelasticsearch_index_stats_fielddata_memory_bytes_totalAmount of fielddata memory in bytesByte
Query Cache Memoryelasticsearch_index_stats_query_cache_memory_bytes_totalAmount of query cache memory in bytesByte
Query Cache Sizeelasticsearch_index_stats_query_cache_sizeSize of the query cache in bytesByte
Request Cache Sizeelasticsearch_index_stats_request_cache_memory_bytes_totalRequest cache size in bytesByte
Metric nameMetric keyDescriptionUnit
Initializing Shardselasticsearch_cluster_health_initializing_shardsNumber of initializing shardsCount
Unassigned Shardselasticsearch_cluster_health_unassigned_shardsNumber of unassigned shardsCount
Relocating Shardselasticsearch_cluster_health_relocating_shardsNumber of relocating shardsCount
Delayed Unassigned Shardselasticsearch_cluster_health_delayed_unassigned_shardsNumber of delayed unassigned shardsCount
Data nodeselasticsearch_cluster_health_number_of_data_nodesNumber of data nodesCount
Customer story BT
“When the system went live, it felt like we had a thousand log analysts helping us understand where to focus efforts to improve our services.”
Chris Deane
Senior Engineering Manager, Cloud Platform Services

Full version history

To have more information on how to install the downloaded package, please follow the instructions on this page.
ReleaseDate

Full version history

⚠️IMPORTANT CHANGE: This extension release requires Dynatrace cluster version 1.310 or later.

New features:

  • Added the Dynatrace Platform (a.k.a. Gen3) dashboard

Full version history

Patch level changes

  • Fixed issues with endpoint authentication under certain circumstances
  • Fixed Number of nodes metrics value reporting when nodes share the same host
  • Fixed inconsistent Query time metric value reporting

Full version history

New features

  • Credentials vault support has been added. Now user name and password required to connect to your ElasticSearch can be stored in a compliant way in the Dynatrace Credentials vault

Breaking change After adopting this release, you have to recreate your monitoring configuration. Apologies for inconvenience, but Credentials vault support change comes with such consequence.

Full version history

Patch level changes:

  • Support for filtering metrics by Management Zones
  • Fix issue with fastcheck using the wrong 'endpoint' variable
  • Fixed a wrong conditional which prevented shards info to be collected

Full version history

Patch level changes

  • When the Elasticsearch API is publicly accessible, no username or password is required.
  • Added a check to verify if username and password are set before setting a basic authentication type

Full version history

New features:

  • support for API token-based authentication to the Elasticsearch endpoint

Full version history

New features

  • Added support for proxy in the remote ElasticSearch cluster connection

Patch level changes

  • Fixed SAME_AS relationship between OneAgent-monitored host and server entities instantiated by this extension

Full version history

This release changes the way how clusters are identified.

  • Now cluster UUID is used instead of cluster name for entity idPattern. This change is necessary to address situations when extension monitors two identical clusters with identical cluster name node names, deployed in different environments, e.g. prod and dev.

This is a breaking change: entities created by previous version of the extension will not be continued and new entities will be created after the extension update. This may affect your custom dashboards and alerts if you created any - they may need an update too.

Additionally, in this release:

  • Fixed issue with fastcheck failing due to activation schema parsing error.

Full version history

Fixed issues with querying endpoints quietly failing. Updated node idPattern to be unique across clusters, so monitoring on multi-cluster, multi-node performance retains correct drill downs and topological relationships.

Full version history

Initial release of the Prometheus-based Elasticsearch monitoring extension. Uses commonly available APIs, no need to enable Prometheus to monitor Elasticsearch.

Dynatrace Hub
Get data into DynatraceBuild your own app
All (771)Log Management and AnalyticsKubernetesAI and LLM ObservabilityInfrastructure ObservabilitySoftware DeliveryApplication ObservabilityApplication SecurityDigital ExperienceBusiness Analytics
Filter
Type
Built and maintained by
Deployment model
SaaS
  • SaaS
  • Managed
Partner FinderBecome a partnerDynatrace Developer

Discover recent additions to Dynatrace

Problems logo

Problems

Analyze abnormal system behavior and performance problems detected by Davis AI.

Logs logo

Logs

Explore all your logs without writing a single query.

Security Investigator logo

Security Investigator

Fast and precise forensics for security and logs on Grail data with DQL queries.

Business Flow logo

Business Flow

Track, analyze, and optimize your critical business processes.

Cost & Carbon Optimization logo

Cost & Carbon Optimization

Track, analyze, and optimize your IT carbon footprint and public cloud costs.

Davis Anomaly Detection logo

Davis Anomaly Detection

Detect anomalies in timeseries using the Davis AI

Analyze your data

Understand your data better with deep insights and clear visualizations.

Notebooks logo

Notebooks

Create powerful, data-driven documents for custom analytics and collaboration.

Dashboards logo

Dashboards

Transform complex data into clear visualizations with custom dashboards.

Automate your processes

Turn data and answers into actions, securely, and at scale.

Workflows logo

Workflows

Automate tasks in your IT landscape, remediate problems, and visualize processes

Jira logo

Jira

Create, query, comment, transition, and resolve Jira tickets within workflows.

Slack logo

Slack

Automate Slack messaging for security incidents, attacks, remediation, and more.

Secure your cloud application

See vulnerabilities and attacks in your environment.

Security Overview logo

Security Overview

Get a comprehensive overview of the security of your applications.

Code-Level Vulnerabilities logo

Code-Level Vulnerabilities

Detect vulnerabilities in your code in real time.

Threats & Exploits logo

Threats & Exploits

Understand, triage, and investigate application security findings and alerts.

Are you looking for something different?

We have hundreds of apps, extensions, and other technologies to customize your environment

Leverage our newest innovations of Dynatrace Saas

Kick-start your app creation

Kick-start your app creation

Whether you’re a beginner or a pro, Dynatrace Developer has the tools and support you need to create incredible apps with minimal effort.
Go to Dynatrace Developer
Upgrading from Dynatrace Managed to SaaS

Upgrading from Dynatrace Managed to SaaS

Drive innovation, speed, and agility in your organization by seamlessly and securely upgrading.
Learn More
Log Management and Analytics

Log Management and Analytics

Innovate faster and more efficiently with unified log management and log analytics for actionable insights and automation.
Learn more