Docs » Configure application receivers » Configure application receivers for hosts and servers » Elasticsearch

Elasticsearch 🔗

Description 🔗

The Splunk Distribution of OpenTelemetry Collector provides this integration as the Elasticsearch monitor via the Smart Agent Receiver.

This monitor collects stats from Elasticsearch. It collects node, cluster, and index level stats.

By default, this monitor only collects cluster level and index level stats from the current master in an Elasticsearch cluster. It is possible to override this using the clusterHealthStatsMasterOnly and indexStatsMasterOnly configuration options respectively.

Installation 🔗

This monitor is available in the SignalFx Smart Agent Receiver, which is part of the Splunk Distribution of OpenTelemetry Collector.

To install this integration:

  1. Deploy the Splunk Distribution of OpenTelemetry Collector to your host or container platform.

  2. Configure the monitor, as described in the next section.

Configuration 🔗

The Splunk Distribution of OpenTelemetry Collector allows embedding a Smart Agent monitor configuration in an associated Smart Agent Receiver instance.

Note: Providing an Elasticsearch monitor entry in your Smart Agent or Collector configuration is required for its use. Use the appropriate form for your agent type.

Smart Agent 🔗

To activate this monitor in the Smart Agent, add the following to your agent configuration:

monitors:  # All monitor config goes under this key
 - type: elasticsearch
   ...  # Additional config

See Smart Agent example configuration for an autogenerated example of a YAML configuration file, with default values where applicable.

Splunk Distribution of OpenTelemetry Collector 🔗

To activate this monitor in the OpenTelemetry Collector, add the following to your agent configuration:

receivers:
  smartagent/elasticsearch:
    type: elasticsearch
    ... # Additional config

To complete the monitor activation, you must also include the smartagent/elasticsearch receiver item in a metrics pipeline. To do this, add the receiver item to the service > pipelines > metrics > receivers section of your configuration file.

See configuration examples for specific use cases that show how the collector can integrate and complement existing environments.

Configuration settings 🔗

The following table shows the configuration options for this monitor:

Option Required Type Description
host yes string
port yes string
username no string Username used to access Elasticsearch stats API
password no string Password used to access Elasticsearch stats API
useHTTPS no bool Whether to use https or not (default: false)
httpHeaders no map of strings A map of HTTP header names to values. Comma separated multiple values for the same message-header is supported.
skipVerify no bool If useHTTPS is true and this option is also true, the exporter's TLS cert will not be verified. (default: false)
caCertPath no string Path to the CA cert that has signed the TLS cert, unnecessary if skipVerify is set to false.
clientCertPath no string Path to the client TLS cert to use for TLS required connections
clientKeyPath no string Path to the client TLS key to use for TLS required connections
cluster no string Cluster name to which the node belongs. This is an optional config that will override the cluster name fetched from a node and will be used to populate the plugin_instance dimension
enableIndexStats no bool Enable Index stats. If set to true, by default the a subset of index stats will be collected (see docs for list of default index metrics collected). (default: true)
indexes no list of strings Indexes to collect stats from (by default stats from all indexes are collected)
indexStatsIntervalSeconds no integer Interval to report IndexStats on (default: 60)
indexSummaryOnly no bool Collect only aggregated index stats across all indexes (default: false)
indexStatsMasterOnly no bool Collect index stats only from Master node (default: true)
enableClusterHealth no bool EnableClusterHealth enables reporting on the cluster health (default: true)
clusterHealthStatsMasterOnly no bool Whether or not non master nodes should report cluster health (default: true)
enableEnhancedHTTPStats no bool Enable enhanced HTTP stats (default: false)
enableEnhancedJVMStats no bool Enable enhanced JVM stats (default: false)
enableEnhancedProcessStats no bool Enable enhanced Process stats (default: false)
enableEnhancedThreadPoolStats no bool Enable enhanced ThreadPool stats (default: false)
enableEnhancedTransportStats no bool Enable enhanced Transport stats (default: false)
enableEnhancedNodeIndicesStats no list of strings Enable enhanced node level index stats groups. A list of index stats groups for which to collect enhanced stats
threadPools no list of strings ThreadPools to report threadpool node stats on (default: [search index])
enableEnhancedClusterHealthStats no bool Enable Cluster level stats. These stats report only from master Elasticserach nodes. (default: false)
enableEnhancedIndexStatsForIndexGroups no list of strings Enable enhanced index level index stats groups. A list of index stats groups for which to collect enhanced stats
enableIndexStatsPrimaries no bool To enable index stats from only primary shards. By default, the index stats collected are aggregated across all shards. (default: false)
metadataRefreshIntervalSeconds no integer How often to refresh metadata about the node and cluster (default: 30)

Example configurations 🔗

The following is an example configuration that collects only default (non-custom) metrics:

monitors:
- type: elasticsearch
  host: localhost
  port: 9200

Enhanced (custom) metrics 🔗

The elasticsearch monitor collects a subset of node stats of JVM, process, HTTP, transport, indices, and thread pool stats. It is possible to enable enhanced stats for each stat group separately. Note that these metrics get categorized under the custom group if you are on host-based pricing. This is an example of a configuration that collects enhanced (custom) metrics:

monitors:
- type: elasticsearch
  host: localhost
  port: 9200
  enableEnhancedHTTPStats: true
  enableEnhancedJVMStats: true
  enableEnhancedProcessStats: true
  enableEnhancedThreadPoolStats: true
  enableEnhancedTransportStats: true
  enableEnhancedNodeIndicesStats:
   - indexing
   - warmer
   - get

The enableEnhancedNodeIndicesStats option takes a list of index stats groups for which enhanced stats will be collected. See Nodes stats API for a comprehensive list of all available groups.

Note that the enableEnhancedIndexStatsForIndexGroups configuration option is similar to the enableEnhancedNodeIndicesStats configuration option, but for index level stats.

Thread pools 🔗

By default, thread pool statistics from the “search” and “index” thread pools are collected. To collect stats from other thread pools, specify the threadPools configuration option, as shown in the following example:

monitors:
- type: elasticsearch
  host: localhost
  port: 9200
  threadPools:
  - bulk
  - warmer
  - listener

The following is a list of valid thread pools by Elasticsearch version:

Thread pool name ES 1.x ES 2.0 ES 2.1+
merge
optimize
bulk
flush
generic
get
snapshot
warmer
refresh
fetch_shard_started
fetch_shard_store
listener
management
percolate
suggest
force_merge

Collecting index statistics 🔗

By default, the configuration parameter indexes is empty, which means that stats are collected on all indexes. To collect statistics from a subset of indexes, set the configuration parameter indexes to a list of the index names you want to collect stats for.

The call to collect index statistics can be CPU-intensive. For this reason, use the indexStatsIntervalSeconds configuration parameter to decrease the reporting interval for nodes that report index statistics.

Primaries versus total 🔗

By default, the monitor collects a subset of index stats of total aggregation type. The total for an index stat aggregates across all shards, whereas primaries only reflect the stats from primary shards. It is possible to enable index stats of only primaries aggregation type. The following is an example configuration that shows how to index stats from primary shards:

monitors:
- type: elasticsearch
  host: localhost
  port: 9200
  enableIndexStatsPrimaries: true

Metrics 🔗

These are the metrics available for this integration.