› › ›

API для получения статистики потоков данных

Получает статистику для одного или нескольких потоков данных.

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

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

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

(объект) Содержит информацию о фрагментах, которые пытались выполнить запрос.

Свойства _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 выше.

Примеры

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

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

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
    }
  ]
}

© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/data-stream-stats-api.html