catスレッドプール（cat thread pool）

cat thread pool API

cat APIは、コマンドラインまたはKibanaコンソールを使用して人間が消費することを目的としています。アプリケーションによる使用は意図されていません。アプリケーションでの使用には、ノード情報APIを使用してください。

クラスター内の各ノードのスレッドプール統計を返します。返される情報には、すべての組み込みスレッドプールとカスタムスレッドプールが含まれます。

Request

GET /_cat/thread_pool/<thread_pool>

GET /_cat/thread_pool

Prerequisites

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

Path parameters

• <thread_pool>
• （オプション、文字列）リクエストを制限するために使用されるスレッドプール名のカンマ区切りリスト。ワイルドカード式を受け入れます。

Query parameters

• format
• （オプション、文字列）HTTP accept headerの短縮版。有効な値にはJSON、YAMLなどが含まれます。
• h
• （オプション、文字列）表示する列名のカンマ区切りリスト。
  列を指定しない場合、APIは以下にリストされたデフォルトの列を返します。1つ以上の列を明示的に指定した場合、指定された列のみが返されます。
  有効な列は：
  • node_name
  • （デフォルト）ノード名、例えばI8hydUG。
  • name
  • （デフォルト）スレッドプールの名前、例えばanalyzeまたはgeneric。
  • active, a
  • （デフォルト）現在のスレッドプール内のアクティブスレッドの数。
  • queue,q
  • （デフォルト）現在のスレッドプールのキュー内のタスクの数。
  • rejected, r
  • （デフォルト）スレッドプールエグゼキュータによって拒否されたタスクの数。
  • completed, c
  • スレッドプールエグゼキュータによって完了したタスクの数。
  • core, cr
  • 現在のスレッドプールで許可されているアクティブスレッドの構成されたコア数。
  • ephemeral_id,eid
  • 一時的なノードID。
  • host, h
  • 現在のノードのホスト名。
  • ip, i
  • 現在のノードのIPアドレス。
  • keep_alive, k
  • スレッドのために構成されたキープアライブ時間。
  • largest, l
  • 現在のスレッドプール内のアクティブスレッドの最大数。
  • max, mx
  • 現在のスレッドプールで許可されているアクティブスレッドの最大数。
  • node_id, id
  • ノードのID、例えばk0zy。
  • pid, p
  • 実行中のノードのプロセスID。
  • pool_size, psz
  • 現在のスレッドプール内のスレッドの数。
  • port, po
  • 現在のノードのバウンドトランスポートポート。
  • queue_size, qs
  • 現在のスレッドプールのキュー内で許可されているタスクの最大数。
  • size, sz
  • 現在のスレッドプールで許可されている固定数のアクティブスレッド。
  • type, t
  • スレッドプールのタイプ。返される値はfixed、fixed_auto_queue_size、direct、またはscalingです。
• help
• （オプション、Boolean）trueの場合、レスポンスにはヘルプ情報が含まれます。デフォルトはfalseです。
• local
• （オプション、Boolean）trueの場合、リクエストはローカルノードからのみ情報を取得します。デフォルトはfalseで、これはマスターノードから情報を取得することを意味します。
• master_timeout
• （オプション、時間単位）マスターノードを待機する期間。タイムアウトが切れる前にマスターノードが利用できない場合、リクエストは失敗し、エラーを返します。デフォルトは30sです。リクエストがタイムアウトしないことを示すために-1に設定することもできます。
• s
• （オプション、文字列）レスポンスをソートするために使用される列名または列エイリアスのカンマ区切りリスト。
• time
• （オプション、時間単位）時間値を表示するために使用される単位。
• v
• （オプション、Boolean）trueの場合、レスポンスには列見出しが含まれます。デフォルトはfalseです。

Examples

Example with default columns

Python

resp = client.cat.thread_pool()
print(resp)

Ruby

response = client.cat.thread_pool
puts response

Js

const response = await client.cat.threadPool();
console.log(response);

Console

GET /_cat/thread_pool

APIは以下のレスポンスを返します：

Txt

node-0 analyze             0 0 0
...
node-0 fetch_shard_started 0 0 0
node-0 fetch_shard_store   0 0 0
node-0 flush               0 0 0
...
node-0 write               0 0 0

Example with explicit columns

以下のAPIリクエストは、id、name、active、rejected、およびcompleted列を返します。リクエストは返される情報をgenericスレッドプールに制限します。

Python

resp = client.cat.thread_pool(
   thread_pool_patterns="generic",
   v=True,
   h="id,name,active,rejected,completed",
)
print(resp)

Ruby

response = client.cat.thread_pool(
  thread_pool_patterns: 'generic',
  v: true,
  h: 'id,name,active,rejected,completed'
)
puts response

Js

const response = await client.cat.threadPool({
  thread_pool_patterns: "generic",
  v: "true",
  h: "id,name,active,rejected,completed",
});
console.log(response);

Console

GET /_cat/thread_pool/generic?v=true&h=id,name,active,rejected,completed

APIは以下のレスポンスを返します：

Txt

id                     name    active rejected completed
0EWUhXeBQtaVGlexUeVwMg generic      0        0        70