› › ›

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

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

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

Статистика подсказок для автодополнения.

docs

Количество документов и удалённых документов, которые ещё не были объединены. Операции обновления индексов могут влиять на эту статистику.

fielddata

Статистика fielddata.

flush

Статистика сброса.

get

Получение статистики, включая отсутствующие.

indexing

Статистика индексирования.

merge

Статистика слияния.

query_cache

Статистика кэша запросов.

refresh

Статистика обновления.

request_cache

Статистика кэша запросов фрагментов.

search

Статистика поиска, включая статистику подсказок. Можно включить статистику для пользовательских групп, добавив дополнительный параметр groups (операции поиска могут быть связаны с одной или несколькими группами). Параметр groups принимает список имён групп, разделённых запятыми. Используйте _all, чтобы вернуть статистику для всех групп.

segments

Использование памяти всех открытых сегментов.

Если параметр include_segment_file_sizes равен true, эта метрика включает агрегированный объём дискового пространства каждого файла индекса Lucene.

store

Размер индекса в байтах.

translog

Статистика транслога.

warmer

Статистика подогревателей.

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

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.

Примеры

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

GET /index1,index2/_stats

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

GET /_stats

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

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

GET /_stats/merge,refresh

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

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

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