Elasticsearch stats

Use this Splunk Observability Cloud integration for the Elasticsearch monitor. See benefits, install, configuration, and metrics

The Splunk Distribution of the OpenTelemetry Collector uses the Smart Agent receiver with the Elasticsearch monitor type to collect node, cluster, and index level stats from Elasticsearch.

By default, this integration only collects cluster-level and index-level stats from the current primary in an Elasticsearch cluster. You can override this using the clusterHealthStatsMasterOnly and indexStatsMasterOnly configuration options respectively.

Benefits

インテグレーションを設定すると、これらの機能にアクセスできるようになります：

Installation

このインテグレーションを導入するには、以下の手順に従ってください：

  1. Splunk Distribution of OpenTelemetry Collector をホストまたはコンテナプラットフォームにデプロイします：

  2. 設定のセクションで説明するように、モニターを設定します。

  3. Splunk Distribution of OpenTelemetry Collector を再起動します。

Configuration

Smart Agent モニターとCollector のインテグレーションを使用するには、以下の手順に従います：

  1. Smart Agent レシーバーを設定ファイルに含めます。

  2. レシーバーセクションおよびパイプラインセクションの両方で、Collector 構成にモニタータイプを追加します。

Example

To activate this integration, add the following to your Collector configuration:

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

For instance, to collects only default (non-custom) metrics:

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

Next, add the monitor to the service.pipelines.metrics.receivers section of your configuration file:

service:
  pipelines:
    metrics:
      receivers: [smartagent/elasticsearch]

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

Activate 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 primary node (default:

true)

enableClusterHealth

no

bool

Activates reporting on the cluster health (default:

true)

clusterHealthStatsMasterOnly

no

bool

Whether or not non primary nodes should report cluster health

(default: true)

enableEnhancedHTTPStats

no

bool

Activate enhanced HTTP stats (default: false)

enableEnhancedJVMStats

no

bool

Activate enhanced JVM stats (default: false)

enableEnhancedProcessStats

no

bool

Activate enhanced Process stats (default: false)

enableEnhancedThreadPoolStats

no

bool

Activate enhanced ThreadPool stats (default: false)

enableEnhancedTransportStats

no

bool

Activate enhanced Transport stats (default: false)

enableEnhancedNodeIndicesStats

no

list of strings

Activate 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

Activate Cluster level stats. These stats report only from

primary Elasticserach nodes. (default: false)

enableEnhancedIndexStatsForIndexGroups

no

list of strings

Activate enhanced index level index stats groups. A list of

index stats groups for which to collect enhanced stats

enableIndexStatsPrimaries

no

bool

To activate 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)

Advanced configuration examples

Enhanced (custom) metrics

The elasticsearch integration collects a subset of node stats of JVM, process, HTTP, transport, indices, and thread pool stats. It is possible to activate 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 integration 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 activate index stats of only primaries aggregation type. The following is an example configuration that shows how to activate index stats from primary shards:

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

Metrics

The following metrics are available for this integration:

https://raw.githubusercontent.com/signalfx/splunk-otel-collector/main/internal/signalfx-agent/pkg/monitors/elasticsearch/stats/metadata.yaml

Notes

  • Splunk Observability Cloud で利用可能なメトリクスタイプの詳細は、「メトリクスタイプ」を参照してください。

  • ホストベースのサブスクリプションプランでは、デフォルトのメトリクスは、ホスト、コンテナ、バンドルメトリクスなど、Splunk Observability Cloud のホストベースのサブスクリプションに含まれるメトリクスです。カスタムメトリクスはデフォルトでは提供されていないため、料金が発生する場合があります。詳細については、「メトリクスカテゴリ」を参照してください。

  • MTSベースのサブスクリプションプランでは、すべてのメトリクスがカスタムです。

  • メトリクスを追加するには、「その他のメトリクスの追加」で extraMetrics の設定方法を参照してください。

Troubleshooting

__ ___ ___ _ ______ _____________ _____ ________ ___ ___ ___ ____ __ ___ ____ ____ __ ______ _____________ ______ ___ ___ ___ ____ __ ___ _________ _____

_________ __ ______ _____________ _____ _________

_________ __ ___________ _________ ___ ____ _____ _____

  • ___ _ ________ ___ ___ _______ _______ _________ _______ __ ______ ________

  • ____ ___ ______ ______________ ____ _____ _____ _______ __ ___________ ____ __________ _________ ___ ______ _________ __________ __ _____ ___ ____ _______