数据流统计 API编辑

检索一个或多个 数据流 的统计信息。

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

先决条件编辑

  • 如果启用了 Elasticsearch 安全功能,您必须对数据流具有 monitormanage 索引权限

请求编辑

GET /_data_stream/<data-stream>/_stats

路径参数编辑

<data-stream>

(可选,字符串) 用于限制请求的数据流的逗号分隔列表。支持通配符表达式 (*)。

要定位集群中的所有数据流,请省略此参数或使用 *

查询参数编辑

expand_wildcards

(可选,字符串) 通配符模式可以匹配的数据流类型。支持逗号分隔的值,例如 open,hidden。有效值为

all, hidden
匹配任何数据流,包括 隐藏 的数据流。
open, closed
匹配任何非隐藏的数据流。数据流不能关闭。
none
不接受通配符模式。

默认为 open

human
(可选,布尔值) 如果为 true,则响应将包含以人类可读的 字节值 表示的统计信息。默认为 false

响应主体编辑

_shards

(对象) 包含有关尝试执行请求的分片的信息。

属性 _shards
total
(整数) 尝试执行请求的分片总数。
successful
(整数) 成功执行请求的分片数。
failed
(整数) 无法执行请求的分片数。
data_stream_count
(整数) 选定数据流的总数。
backing_indices
(整数) 选定数据流的备份索引总数。
total_store_size
(字节值) 选定数据流的所有分片的总大小。仅当 human 查询参数为 true 时,才会包含此属性。
total_store_size_bytes
(整数) 选定数据流的所有分片的总大小(以字节为单位)。
data_streams

(对象数组) 包含选定数据流的统计信息。

对象 data_streams 中的属性
data_stream
(字符串) 数据流的名称。
backing_indices
(整数) 数据流的当前备份索引数。
store_size
(字节值) 数据流备份索引的所有分片的总大小。仅当 human 查询参数为 true 时,才会返回此参数。
store_size_bytes
(整数) 数据流备份索引的所有分片的总大小(以字节为单位)。
maximum_timestamp

(整数) 数据流的最高 @timestamp 值,转换为自 Unix 纪元 以来经过的毫秒数。

如果满足以下一个或多个条件,则数据流可能包含高于此值的 @timestamp

  • 该流包含 关闭 的备份索引。
  • 具有 较低生成 的备份索引包含较高的 @timestamp 值。

示例编辑

response = client.indices.data_streams_stats(
  name: 'my-data-stream*',
  human: true
)
puts 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
    }
  ]
}