クラスター情報（Cluster Info）

Cluster Info API

この機能は技術プレビュー中であり、将来のリリースで変更または削除される可能性があります。Elasticは問題を修正するために取り組みますが、技術プレビューの機能は公式GA機能のサポートSLAの対象ではありません。

クラスター情報を返します。

Request

GET /_info/<target>

Prerequisites

• Elasticsearchのセキュリティ機能が有効になっている場合、このAPIを使用するにはmonitorまたはmanage クラスター権限が必要です。

Description

Cluster Info APIを使用して、クラスターの情報を取得できます。

Path parameters

• <target>
• (String) 返される情報を特定のtargetに制限します。以下のオプションのカンマ区切りリスト:
  • _all
  • 利用可能なすべての情報。 他のターゲットと混在させることはできません。
  • http
  • HTTP接続情報。
  • ingest
  • インジェスト情報。
  • thread_pool
  • 各スレッドプールに関する統計、現在のサイズ、キューサイズ、拒否されたタスクを含みます。
  • script
  • クラスターのスクリプト統計を含みます。

Response body

• cluster_name

• (string) クラスターの名前。クラスター名設定に基づいています。

• http

• (object) クラスターのHTTP情報を含みます。

  -   `````current_open

  • (integer) クラスターの現在のオープンHTTP接続数。
  • total_opened
  • (integer) クラスターのオープンHTTP接続の総数。
  • clients
  • (array of objects) 現在および最近閉じたHTTPクライアント接続に関する情報。 http.client_stats.closed_channels.max_age設定よりも長く閉じられたクライアントはここには表示されません。

    -   `````id

    • (integer) HTTPクライアントのユニークID。
    • agent
    • (string) HTTPクライアントの報告されたエージェント。 利用できない場合、このプロパティはレスポンスに含まれません。
    • local_address
    • (string) HTTP接続のローカルアドレス。
    • remote_address
    • (string) HTTP接続のリモートアドレス。
    • last_uri
    • (string) クライアントの最新のリクエストのURI。
    • x_forwarded_for
    • (string) クライアントのx-forwarded-for HTTPヘッダーからの値。 利用できない場合、このプロパティはレスポンスに含まれません。
    • x_opaque_id
    • (string) クライアントのx-opaque-id HTTPヘッダーからの値。 利用できない場合、このプロパティはレスポンスに含まれません。
    • opened_time_millis
    • (integer) クライアントが接続を開いた時刻。
    • closed_time_millis
    • (integer) 接続が閉じられた場合、クライアントが接続を閉じた時刻。
    • last_request_time_millis
    • (integer) このクライアントからの最新のリクエストの時刻。
    • request_count
    • (integer) このクライアントからのリクエストの数。
    • request_size_bytes
    • (integer) このクライアントからのすべてのリクエストの累積サイズ（バイト単位）。

• ingest

• (object) クラスターのインジェスト情報を含みます。

  -   `````total

  • (object) クラスターのインジェスト操作に関する情報を含みます。

    -   `````count

    • (integer) クラスター全体でインジェストされたドキュメントの総数。
    • time
    • (time value) クラスター全体でインジェストドキュメントの前処理に費やされた総時間。
    • time_in_millis
    • (integer) クラスター全体でインジェストドキュメントの前処理に費やされた総時間（ミリ秒単位）。
    • current
    • (integer) 現在インジェスト中のドキュメントの総数。
    • failed
    • (integer) クラスター全体で失敗したインジェスト操作の総数。
  • pipelines
  • (object) クラスターのインジェストパイプラインに関する情報を含みます。

    -   `````<pipeline_id>

    • (object) インジェストパイプラインに関する情報を含みます。
      <pipeline_id>のプロパティ
    • count
    • (integer) インジェストパイプラインによって前処理されたドキュメントの数。
    • time
    • (time value) インジェストパイプラインでドキュメントの前処理に費やされた総時間。
    • time_in_millis
    • (integer) インジェストパイプラインでドキュメントの前処理に費やされた総時間（ミリ秒単位）。
    • failed
    • (integer) インジェストパイプラインの失敗した操作の総数。
    • ingested_as_first_pipeline
    • (byte value) このパイプラインによって最初に処理されたすべてのドキュメントの総インジェストサイズ。 ドキュメントがデフォルトパイプラインの後の最終パイプラインである場合、リルートプロセッサの後のパイプラインである場合、またはパイプラインプロセッサ内にある場合、このパイプラインの統計値には追加されません。 代わりに、ドキュメントサイズは、最初にドキュメントをインジェストしたパイプラインの統計値に追加されます。
    • ingested_as_first_pipeline_in_bytes
    • (integer) このパイプラインによって最初に処理されたすべてのドキュメントの総インジェストサイズ（バイト単位）。 ドキュメントがデフォルトパイプラインの後の最終パイプラインである場合、リルートプロセッサの後のパイプラインである場合、またはパイプラインプロセッサ内にある場合、このパイプラインの統計値には追加されません。 代わりに、ドキュメントサイズは、最初にドキュメントをインジェストしたパイプラインの統計値に追加されます。
    • produced_as_first_pipeline
    • (byte value) このパイプラインによって最初に処理されたすべてのドキュメントの総生成サイズ。 ドキュメントがデフォルトパイプラインの後の最終パイプラインである場合、リルートプロセッサの後のパイプラインである場合、またはパイプラインプロセッサ内にある場合、このパイプラインの統計値には追加されません。 代わりに、ドキュメントサイズは、最初にドキュメントをインジェストしたパイプラインの統計値に追加されます。
    • produced_as_first_pipeline_in_bytes
    • (integer) このパイプラインによって最初に処理されたすべてのドキュメントの総生成サイズ（バイト単位）。 ドキュメントがデフォルトパイプラインの後の最終パイプラインである場合、リルートプロセッサの後のパイプラインである場合、またはパイプラインプロセッサ内にある場合、このパイプラインの統計値には追加されません。 代わりに、ドキュメントサイズは、最初にドキュメントをインジェストしたパイプラインの統計値に追加されます。
    • processors
    • (array of objects) インジェストパイプラインのインジェストプロセッサに関する情報を含みます。

      -   `````<processor>

      • (object) インジェストプロセッサに関する情報を含みます。

        -   `````count

        • (integer) プロセッサによって変換されたドキュメントの数。
        • time
        • (time value) ドキュメントを変換するためにプロセッサが費やした時間。
        • time_in_millis
        • (integer) ドキュメントを変換するためにプロセッサが費やした時間（ミリ秒単位）。
        • current
        • (integer) 現在プロセッサによって変換されているドキュメントの数。
        • failed
        • (integer) プロセッサの失敗した操作の数。

• thread_pool

• (object) クラスターのスレッドプールに関する情報を含みます。

  -   `````<thread_pool_name>

  • (object) <thread_pool_name>という名前のクラスターのスレッドプールに関する情報を含みます。

    -   `````threads

    • (integer) スレッドプール内のスレッドの数。
    • queue
    • (integer) スレッドプールのキュー内のタスクの数。
    • active
    • (integer) スレッドプール内のアクティブなスレッドの数。
    • rejected
    • (integer) スレッドプールエグゼキュータによって拒否されたタスクの数。
    • largest
    • (integer) スレッドプール内のアクティブなスレッドの最大数。
    • completed
    • (integer) スレッドプールエグゼキュータによって完了したタスクの数。

• script
• (object) クラスターのスクリプト統計を含みます。

  -   `````compilations

  • (integer) クラスターによって実行されたインラインスクリプトコンパイルの総数。
  • compilations_history
  • (object) スクリプトコンパイルの最近の履歴を含みます。
    compilations_historyのプロパティ
  • 5m
  • (long) 過去5分間のスクリプトコンパイルの数。
  • 15m
  • (long) 過去15分間のスクリプトコンパイルの数。
  • 24h
  • (long) 過去24時間のスクリプトコンパイルの数。
  • cache_evictions
  • (integer) スクリプトキャッシュが古いデータを排出した回数の合計。
  • cache_evictions_history
  • (object) スクリプトキャッシュの排出の最近の履歴を含みます。
    cache_evictionsのプロパティ
  • 5m
  • (long) 過去5分間のスクリプトキャッシュの排出の数。
  • 15m
  • (long) 過去15分間のスクリプトキャッシュの排出の数。
  • 24h
  • (long) 過去24時間のスクリプトキャッシュの排出の数。
  • compilation_limit_triggered
  • (integer) スクリプトコンパイルサーキットブレーカーがインラインスクリプトコンパイルを制限した回数の合計。

Examples

Python

resp = client.cluster.info(
   target="_all",
)
print(resp)
resp1 = client.cluster.info(
   target="http",
)
print(resp1)
resp2 = client.cluster.info(
   target="ingest",
)
print(resp2)
resp3 = client.cluster.info(
   target="thread_pool",
)
print(resp3)
resp4 = client.cluster.info(
   target="script",
)
print(resp4)
resp5 = client.cluster.info(
   target="http,ingest",
)
print(resp5)

Ruby

response = client.cluster.info(
  target: '_all'
)
puts response
response = client.cluster.info(
  target: 'http'
)
puts response
response = client.cluster.info(
  target: 'ingest'
)
puts response
response = client.cluster.info(
  target: 'thread_pool'
)
puts response
response = client.cluster.info(
  target: 'script'
)
puts response
response = client.cluster.info(
  target: 'http,ingest'
)
puts response

Js

const response = await client.cluster.info({
  target: "_all",
});
console.log(response);
const response1 = await client.cluster.info({
  target: "http",
});
console.log(response1);
const response2 = await client.cluster.info({
  target: "ingest",
});
console.log(response2);
const response3 = await client.cluster.info({
  target: "thread_pool",
});
console.log(response3);
const response4 = await client.cluster.info({
  target: "script",
});
console.log(response4);
const response5 = await client.cluster.info({
  target: "http,ingest",
});
console.log(response5);

Console

# returns all stats info of the cluster
GET /_info/_all
# returns the http info of the cluster
GET /_info/http
# returns the http info of the cluster
GET /_info/ingest
# returns the thread_pool info of the cluster
GET /_info/thread_pool
# returns the script info of the cluster
GET /_info/script
# returns the http and ingest info of the cluster
GET /_info/http,ingest