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 pages 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
Licensing and costs
There is no charge to use the extension. You are only charged for the data that the extension ingests.
The following formula provides the number of metric data points per minute, assuming all feature sets are enabled.
(12 * number of clusters)
+ (53 * number of nodes)
+ (47 * number of indexes)
+ ( 5 * number of disks)
+ ( 5 * number of thread pools)
This gives you the number of metric data points ingested per monitoring interval.
Dynatrace Platform Subscription
In the Dynatrace Platform Subscription, metric ingestion consumes Metrics powered by Grail according to the number of ingested metric data points.
To calculate the approximate yearly consumption, apply the following calculation: <metric data points per minute> * 60 minutes * 24 hours * 365 days.
For logs, regular consumption applies. See Log Analytics.
Dynatrace classic license
In the classic licensing model, metric ingestion consumes Davis Data Units (DDUs) at the rate of .001 DDUs per metric data point. Multiply the above formula for annual data points by .001 to estimate annual DDU usage.
The DDU cost above does not include any possible log events or custom events that are triggered by the extension. For more information, see DDU events.
Feature sets
When activating your extension using a 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.
node-filesystem-basic
Metric name
Metric key
Description
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
Metric name
Metric key
Description
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
