Elasticsearch receiver 🔗

The Elasticsearch receiver queries Elasticsearch’s node stats, cluster health and index stats endpoints to scrape metrics from a running Elasticsearch cluster. The supported pipeline type is metrics. See パイプラインでデータを処理する for more information.

注釈

Out-of-the-box dashboards and navigators aren’t supported for the Elasticsearch receiver yet, but are planned for a future release.

To learn more about the queried endpoints see:

前提条件 🔗

This receiver supports Elasticsearch versions 7.9 or higher.

If Elasticsearch security features are enabled, you must have either the monitor or manage cluster privilege. See Elasticsearch’s Role-based access control and Security privileges for more information on authorization and security privileges.

はじめに 🔗

以下の手順に従って、コンポーネントの設定とアクティベーションを行ってください：

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

インストーラ・スクリプトを使用して Linux 用 Collector をインストールします。

インストーラ・スクリプトを使用して Collector for Windows をインストールします。

Install the Collector for Kubernetes using Helm

Configure the Elasticsearch receiver as described in the next section.
Collector を再起動します。

サンプル構成 🔗

To activate the receiver, add elasticsearch to the receivers section of your configuration file:

receivers:
    elasticsearch:

次に、設定ファイルの service セクションの metrics パイプラインに、レシーバーを含めます：

service:
  pipelines:
    metrics:
      receivers:
        - elasticsearch

高度な設定 🔗

以下の設定はオプションです：

nodes. ["_all"] by default. Allows you to specify node filters that define which nodes are scraped for node-level and cluster-level metrics.
- See Elasticsearch’s Cluster APIs Node specification for allowed filters.
- If empty, then the receiver doesn’t scrape any node-level metrics, and only metrics related to the cluster’s health are scraped at the cluster level.
skip_cluster_metrics. false by default. If true, cluster-level metrics are not scraped.
indices. ["_all"] by default. Allows you to specify index filters that define which indices are scraped for index-level metrics.
- See Elasticsearch’s Cluster APIs Path parameters for allowed filters.
- If empty, then the receiver doesn’t scrape any index-level metrics.
endpoint. http://localhost:9200 by default. The base URL of the Elasticsearch API for the cluster to monitor.
username. No default. Specifies the username used to authenticate with Elasticsearch using basic auth.
password. No default. Specifies the password used to authenticate with Elasticsearch using basic auth.
collection_interval. 10s by default. This receiver collects metrics on an interval determined by this setting. This value must be a string readable by Golang’s time.ParseDuration .
- On larger clusters, you might need to increase this interval, as querying Elasticsearch for metrics takes longer on clusters with more nodes.
initial_delay デフォルトでは 1s 。このレシーバーが開始するまでの待ち時間を定義します。

設定例 🔗

See the following configuration example:

receivers:
  elasticsearch:
    metrics:
      elasticsearch.node.fs.disk.available:
        enabled: false
    nodes: ["_local"]
    skip_cluster_metrics: true
    indices: [".geoip_databases"]
    endpoint: http://localhost:9200
    username: otel
    password: password
    collection_interval: 10s

設定 🔗

The following table shows the configuration options for the Elasticsearch receiver:

メトリクス 🔗

以下のメトリクス、リソース属性、および属性が利用可能です。

特定のメトリクスをアクティブまたは非アクティブにする 🔗

各メトリクスの metrics セクションの enabled フィールドを設定することで、特定のメトリクスをアクティブまたは非アクティブにできます。例：

receivers:
  samplereceiver:
    metrics:
      metric-one:
        enabled: true
      metric-two:
        enabled: false

以下は、アクティブ化されたメトリクスを持つホスト・メトリクス・レシーバーの構成例です：

receivers:
  hostmetrics:
    scrapers:
      process:
        metrics:
          process.cpu.utilization:
            enabled: true

注釈

無効化されたメトリクスは Splunk Observability Cloud に送信されません。

Billing 🔗

If you’re in a MTS-based subscription, all metrics count towards metrics usage.
If you’re in a host-based plan, metrics listed as active (Active: Yes) on this document are considered default and are included free of charge.

Learn more at Infrastructure Monitoringのサブスクリプション使用状況（ホストとメトリクスのプラン）.

Metrics with versions 🔗

The following metric are available with versions:

elasticsearch.indexing_pressure.memory.limit. Available in versions 7.10 or higher.
elasticsearch.node.shards.data_set.size. Available in versions 7.13 or higher.
elasticsearch.cluster.state_update.count. Available in versions 7.16.0 or higher.
elasticsearch.cluster.state_update.time. Available in versions 7.16.0 or higher.

トラブルシューティング 🔗

Splunk Observability Cloudをご利用のお客様で、Splunk Observability Cloudでデータを確認できない場合は、以下の方法でサポートを受けることができます。

Splunk Observability Cloudをご利用のお客様

Submit a case in the Splunk Support Portal .
Contact Splunk Support .

見込み客および無料トライアルユーザー様

Splunk Answers のコミュニティサポートで質問し、回答を得る
Splunk #observability ユーザーグループの Slack チャンネルに参加して、世界中の顧客、パートナー、Splunk 社員とのコミュニケーションを図る。参加するには、Get Started with Splunk Community マニュアルのチャットグループを参照してください。

This page was last updated on 2024年11月13日.

Related Topics