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.
注釈
すぐに使えるダッシュボードとナビゲーターはまだElasticsearchレシーバーではサポートされていませんが、将来のリリースではサポートされる予定です。
To learn more about the queried endpoints see:
前提条件 🔗
This receiver supports Elasticsearch versions 7.9 or higher.
Elasticsearchのセキュリティ機能が有効になっている場合、monitor権限かmanage cluster権限のどちらかが必要です。権限とセキュリティ権限の詳細についてはElasticsearchの ロールベースのアクセス制御 と セキュリティ権限 を参照してください。
はじめに 🔗
以下の手順に従って、コンポーネントの設定とアクティベーションを行ってください:
Splunk Distribution of the OpenTelemetry Collector をホストまたはコンテナプラットフォームにデプロイします:
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"]
です。ノードレベルおよびクラスターレベルのメトリクスをスクレイピングするノードを定義するノードフィルターを指定できます。See Elasticsearch’s Cluster APIs Node specification for allowed filters.
空の場合、レシーバーはノードレベルのメトリクスをスクレイピングせず、クラスターの健全性に関連するメトリクスのみがクラスターレベルでスクレイピングされます。
skip_cluster_metrics
。デフォルトではfalse
。true
の場合、クラスターレベルのメトリクスはスクレイピングされません。indices
。デフォルトでは["_all"]
です。どのインデックスがインデックスレベルのメトリクスをスクレイピングするかを定義するインデックスフィルターを指定できます。See Elasticsearch’s Cluster APIs Path parameters for allowed filters.
空の場合、レシーバーはインデックスレベルのメトリクスをスクレイピングしません。
endpoint
。デフォルトではhttp://localhost:9200
です。監視するクラスターのElasticsearch APIのベース URL。username
。デフォルトはありません。基本認証を使用してElasticsearchで認証する際に使用するユーザー名を指定します。password
。デフォルトはありません。基本認証を使用してElasticsearchで認証に使用するパスワードを指定します。collection_interval
。デフォルトでは10s
です。このレシーバーは、この設定で決定された間隔でメトリクスを収集します。この値は、Golangの time.ParseDuration で読める文字列でなければなりません。大きいクラスターでは、ノードの多いクラスターでElasticsearchにメトリクスをクエリするのに時間がかかるため、間隔を伸ばす必要がある場合があります。
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.
ホストベースのプランに加入している場合、このドキュメントでアクティブ(Active: Yes)と記載されているメトリクスはデフォルトとみなされ、無料で含まれます。
Learn more at Infrastructure Monitoringのサブスクリプション使用状況(ホストとメトリクスのプラン).
Metrics with versions 🔗
The following metric are available with versions:
elasticsearch.indexing_pressure.memory.limit
。バージョン7.10以上で利用可能です。elasticsearch.node.shards.data_set.size
。バージョン7.13以上で利用可能です。elasticsearch.cluster.state_update.count
。バージョン7.16.0以上で利用可能です。elasticsearch.cluster.state_update.time
。バージョン7.16.0以上で利用可能です。
トラブルシューティング 🔗
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 マニュアルの チャットグループ を参照してください。