データストリーム統計（Data stream stats）

データストリーム統計API

1つ以上のdata streamsの統計を取得します。

Python

resp = client.indices.data_streams_stats(
   name="my-data-stream",
)
print(resp)

Ruby

response = client.indices.data_streams_stats(
  name: 'my-data-stream'
)
puts response

Js

const response = await client.indices.dataStreamsStats({
  name: "my-data-stream",
});
console.log(response);

コンソール

GET /_data_stream/my-data-stream/_stats

前提条件

• Elasticsearchのセキュリティ機能が有効になっている場合、データストリームのためにmonitorまたはmanageインデックス権限を持っている必要があります。

リクエスト

GET /_data_stream/<data-stream>/_stats

パスパラメータ

• <data-stream>
• （オプション、文字列）リクエストを制限するために使用されるデータストリームのカンマ区切りリスト。ワイルドカード表現（*）がサポートされています。
  クラスター内のすべてのデータストリームをターゲットにするには、このパラメータを省略するか、*を使用します。

クエリパラメータ

• expand_wildcards
• （オプション、文字列）ワイルドカードパターンが一致できるデータストリームのタイプ。カンマ区切りの値（例：open,hidden）をサポートします。有効な値は：
  • all, hidden
  • すべてのデータストリームに一致し、隠しデータストリームも含まれます。
  • open, closed
  • 隠されていないデータストリームに一致します。データストリームは閉じることができません。
  • none
  • ワイルドカードパターンは受け付けられません。
    デフォルトはopenです。
• human
• （オプション、ブール値）trueの場合、応答には人間が読みやすいバイト値の統計が含まれます。デフォルトはfalseです。

レスポンスボディ

• _shards
• （オブジェクト）リクエストを実行しようとしたシャードに関する情報を含みます。

  -   `````total

  • （整数）リクエストを実行しようとしたシャードの総数。
  • successful
  • （整数）リクエストを正常に実行したシャードの数。
  • failed
  • （整数）リクエストの実行に失敗したシャードの数。
• data_stream_count
• （整数）選択されたデータストリームの総数。
• backing_indices
• （整数）選択されたデータストリームのバックインデックスの総数。
• total_store_size
• （[バイト値](b10cb0563daae284.md#byte-units））選択されたデータストリームのすべてのシャードの合計サイズ。このプロパティは、humanクエリパラメータがtrueの場合にのみ含まれます。
• total_store_size_bytes
• （整数）選択されたデータストリームのすべてのシャードの合計サイズ（バイト単位）。
• data_streams
• （オブジェクトの配列）選択されたデータストリームの統計を含みます。

  -   `````data_stream

  • （文字列）データストリームの名前。
  • backing_indices
  • （整数）データストリームの現在のバックインデックスの数。
  • store_size
  • （[バイト値](b10cb0563daae284.md#byte-units））データストリームのバックインデックスのすべてのシャードの合計サイズ。このパラメータは、humanクエリパラメータがtrueの場合にのみ返されます。
  • store_size_bytes
  • （整数）データストリームのバックインデックスのすべてのシャードの合計サイズ（バイト単位）。
  • maximum_timestamp
  • （整数）データストリームの最高@timestamp値、Unixエポックからミリ秒に変換されます。
    データストリームは、次の条件のいずれかが満たされる場合、これより高い@timestamp値を含むことがあります：
    • ストリームには閉じたバックインデックスが含まれています。
    • 世代が低いバックインデックスがより高い@timestamp値を含んでいます。

例

Python

resp = client.indices.data_streams_stats(
   name="my-data-stream*",
   human=True,
)
print(resp)

Ruby

response = client.indices.data_streams_stats(
  name: 'my-data-stream*',
  human: true
)
puts response

Js

const response = await client.indices.dataStreamsStats({
  name: "my-data-stream*",
  human: "true",
});
console.log(response);

コンソール

GET /_data_stream/my-data-stream*/_stats?human=true

APIは次の応答を返します。

コンソール-結果

{
  "_shards": {
   "total": 10,
   "successful": 5,
   "failed": 0
  },
  "data_stream_count": 2,
  "backing_indices": 5,
  "total_store_size": "7kb",
  "total_store_size_bytes": 7268,
  "data_streams": [
   {
   "data_stream": "my-data-stream",
   "backing_indices": 3,
   "store_size": "3.7kb",
   "store_size_bytes": 3772,
   "maximum_timestamp": 1607512028000
   },
   {
   "data_stream": "my-data-stream-two",
   "backing_indices": 2,
   "store_size": "3.4kb",
   "store_size_bytes": 3496,
   "maximum_timestamp": 1607425567000
   }
  ]
}