› › ›

API статистики использования полей

Данная функция находится на стадии технического предварительного просмотра и может быть изменена или удалена в будущих версиях. Elastic будет работать над исправлением любых проблем, но функции технического предварительного просмотра не подпадают под SLA поддержки официальных функций GA.

Возвращает информацию об использовании полей для каждого фрагмента и поля индекса. Статистика использования полей автоматически собирается, когда запросы выполняются в кластере. Запрос поиска на уровне фрагмента, который обращается к определённому полю, даже если это происходит несколько раз во время этого запроса, считается одним использованием.

GET /my-index-000001/_field_usage_stats

Запрос

GET /<index>/_field_usage_stats

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

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

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

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

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

allow_no_indices

(Необязательно, логическое значение) Если false, запрос возвращает ошибку, если любое выражение с подстановкой, псевдоним индекса или _all значение нацелены только на отсутствующие или закрытые индексы. Это поведение применяется даже если запрос нацелен на другие открытые индексы. Например, запрос, нацеленный на foo*,bar*, возвращает ошибку, если индекс начинается с foo, но ни один индекс не начинается с bar.

expand_wildcards

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

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

ignore_unavailable

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

wait_for_active_shards

(Необязательно, строка) Количество активных копий фрагментов, которое должно быть активным перед продолжением операции. Установите значение all или любое положительное целое число до общего количества фрагментов в индексе (number_of_replicas+1). По умолчанию: 1, первичный фрагмент.

См. Активные фрагменты.

master_timeout

(Необязательно, единицы времени) Период ожидания подключения к узлу-мастеру. Если ответ не получен до истечения срока ожидания, запрос завершается ошибкой. По умолчанию 30s.

timeout

(Необязательно, единицы времени) Период ожидания ответа. Если ответ не получен до истечения срока ожидания, запрос завершается ошибкой. По умолчанию 30s.

fields

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

Примеры

Следующий запрос извлекает информацию об использовании полей индекса my-index-000001 на доступных в настоящее время фрагментах.

GET /my-index-000001/_field_usage_stats

API возвращает следующий ответ:

{
    "_shards": {
        "total": 1,
        "successful": 1,
        "failed": 0
    },
    "my-index-000001": {
        "shards": [
            {
                "tracking_id": "MpOl0QlTQ4SYYhEe6KgJoQ",
                "tracking_started_at_millis": 1625558985010,
                "routing": {
                    "state": "STARTED",
                    "primary": true,
                    "node": "gA6KeeVzQkGURFCUyV-e8Q",
                    "relocating_node": null
                },
                "stats" : {
                    "all_fields": {
                        "any": "6", 
                        "inverted_index": {
                            "terms" : 1,
                            "postings" : 1,
                            "proximity" : 1, 
                            "positions" : 0,
                            "term_frequencies" : 1,
                            "offsets" : 0,
                            "payloads" : 0
                        },
                        "stored_fields" : 2,
                        "doc_values" : 1,
                        "points" : 0,
                        "norms" : 1,
                        "term_vectors" : 0
                    },
                    "fields": {
                        "_id": {
                            "any" : 1,
                            "inverted_index": {
                                "terms" : 1,
                                "postings" : 1,
                                "proximity" : 1,
                                "positions" : 0,
                                "term_frequencies" : 1,
                                "offsets" : 0,
                                "payloads" : 0
                            },
                            "stored_fields" : 1,
                            "doc_values" : 0,
                            "points" : 0,
                            "norms" : 0,
                            "term_vectors" : 0
                        },
                        "_source": {...},
                        "context": {...},
                        "message.keyword": {...}
                    }
                }
            }
        ]
    }
}

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

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