› › ›

API статистики индексов

Возвращает статистику для одного или нескольких индексов. Для потоков данных API возвращает статистику для индексов, лежащих в основе потока.

resp = client.indices.stats(
    index="my-index-000001",
)
print(resp)

response = client.indices.stats(
  index: 'my-index-000001'
)
puts response

const response = await client.indices.stats({
  index: "my-index-000001",
});
console.log(response);

GET /my-index-000001/_stats

Запрос

GET /<target>/_stats/<index-metric>

GET /<target>/_stats

GET /_stats

Предварительные условия

Если включены функции безопасности Elasticsearch, у вас должны быть права monitor или manage права на индексы для целевого потока данных, индекса или псевдонима.

Описание

Используйте API статистики индексов, чтобы получить агрегированную статистику высокого уровня для одного или нескольких потоков данных и индексов.

По умолчанию возвращаемая статистика является уровневой для индексов с primaries и total агрегациями. primaries являются значениями только для первичных фрагментов. total являются накопленными значениями для первичных и реплицирующих фрагментов.

Чтобы получить статистику уровня фрагмента, установите параметр level в shards.

При переключении на другой узел статистика уровня фрагмента для фрагмента очищается. Хотя фрагмент больше не является частью узла, этот узел сохраняет любые статистические данные уровня узла, в которые фрагмент внес вклад.

Параметры пути

<target>

(Необязательно, строка) Список потоков данных, индексов и псевдонимов, разделенных запятыми, используемый для ограничения запроса. Поддерживает подстановки (*). Для таргетирования всех потоков данных и индексов опустите этот параметр или используйте * или _all.

<index-metric>

(Необязательно, строка) Список метрик, разделенных запятыми, используемый для ограничения запроса. Поддерживаемые метрики:

_all: Возвращает всю статистику.
completion: Статистика завершения.
dense_vector: Общее количество индексированных плотных векторов. Обновления индексов могут повлиять на эту статистику.
docs: Количество документов, количество удалённых документов, которые ещё не слиты, и общий размер в байтах. Обновления индексов могут повлиять на эту статистику.
fielddata: Статистика полевых данных.
flush: Статистика очистки.
get: Получение статистики, включая пропущенные данные.
indexing: Статистика индексирования.
merge: Статистика слияния.
query_cache: Статистика кэша запросов.
refresh: Статистика обновления.
request_cache: Статистика кэша запросов фрагментов.
search: Статистика поиска, включая статистику предложений. Вы можете включить статистику для настраиваемых групп, добавив дополнительный параметр groups (операции поиска могут быть связаны с одной или несколькими группами). Параметр groups принимает список имён групп, разделённых запятыми. Используйте _all, чтобы вернуть статистику для всех групп.
segments: Объем памяти всех открытых сегментов.
Если параметр include_segment_file_sizes равен true, эта метрика включает в себя агрегированный объем диска каждого файла индекса Lucene.
sparse_vector: Общее количество индексированных разреженных векторов.

Обновления индексов могут повлиять на эту статистику.

store: Размер индекса в байтах.
translog: Статистика транслога.

Параметры запроса

expand_wildcards

(Необязательно, строка) Тип индекса, с которым могут совпадать шаблоны с подстановкой. Если запрос может таргетировать потоки данных, этот параметр определяет, будут ли подстановки соответствовать скрытым потокам данных. Поддерживает значения, разделённые запятыми, такие как open,hidden. Допустимые значения:

all: Совпадение с любым потоком данных или индексом, включая скрытые.
open: Совпадение с открытыми, нескрытыми индексами. Также соответствует любому нескрытому потоку данных.
closed: Совпадение с закрытыми, нескрытыми индексами. Также соответствует любому нескрытому потоку данных. Потоки данных не могут быть закрыты.
hidden: Совпадение со скрытыми потоками данных и скрытыми индексами. Должен быть объединён с open, closed или обоими.
none: Шаблоны подстановок не принимаются.

По умолчанию open.

fields

(Необязательно, строка) Список полей, разделённых запятыми, или шаблоны с подстановкой для включения в статистику.

Используется как список по умолчанию, если не указан конкретный список полей в параметрах completion_fields или fielddata_fields.

completion_fields

(Необязательно, строка) Список полей, разделённых запятыми, или шаблоны с подстановкой для включения в статистику fielddata и suggest.

fielddata_fields

(Необязательно, строка) Список полей, разделённых запятыми, или шаблоны с подстановкой для включения в статистику fielddata.

forbid_closed_indices

(Необязательно, булево) Если true, статистика не собирается из закрытых индексов. По умолчанию true.

groups

(Необязательно, строка) Список поисковых групп, разделённых запятыми, для включения в статистику search.

level

(Необязательно, строка) Указывает, на каком уровне агрегируется статистика: кластер, индекс или фрагмент. Если запрашивается уровень фрагмента, отображается дополнительная статистика фрагмента.

Допустимые значения:

cluster
indices
shards

include_segment_file_sizes

(Необязательно, булево) Если true, вызов сообщает о суммарном использовании диска каждого файла индекса Lucene (применяется только в случае запроса статистики сегментов). По умолчанию false.

include_unloaded_segments

(Необязательно, булево) Если true, ответ включает информацию из сегментов, которые не загружены в память. По умолчанию false.

Примеры

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

resp = client.indices.stats(
    index="index1,index2",
)
print(resp)

response = client.indices.stats(
  index: 'index1,index2'
)
puts response

const response = await client.indices.stats({
  index: "index1,index2",
});
console.log(response);

GET /index1,index2/_stats

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

resp = client.indices.stats()
print(resp)

response = client.indices.stats
puts response

const response = await client.indices.stats();
console.log(response);

GET /_stats

Получение определенной статистики

Следующий запрос возвращает только статистику merge и refresh для всех индексов.

resp = client.indices.stats(
    metric="merge,refresh",
)
print(resp)

response = client.indices.stats(
  metric: 'merge,refresh'
)
puts response

const response = await client.indices.stats({
  metric: "merge,refresh",
});
console.log(response);

GET /_stats/merge,refresh

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

Следующий запрос возвращает только статистику поиска для групп поиска group1 и group2.

resp = client.indices.stats(
    metric="search",
    groups="group1,group2",
)
print(resp)

response = client.indices.stats(
  metric: 'search',
  groups: 'group1,group2'
)
puts response

const response = await client.indices.stats({
  metric: "search",
  groups: "group1,group2",
});
console.log(response);

GET /_stats/search?groups=group1,group2

© 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/indices-stats.html