Spec-Zone.ru › Elasticsearch 7
›Руководство по Elasticsearch [7.17] ›REST API ›API трансформаций

API получения статистики трансформаций

Получает информацию об использовании трансформаций.

Запрос

GET _transform/<transform_id>/_stats

GET _transform/<transform_id>,<transform_id>/_stats

GET _transform/_stats

GET _transform/_all/_stats

GET _transform/*/_stats

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

Требуются следующие привилегии:

  • cluster: monitor_transform (роль transform_user предоставляет эту привилегию)
  • индекс назначения: read, view_index_metadata.

Описание

Вы можете получить статистику по нескольким трансформациям в одном запросе API, используя список идентификаторов, разделенных запятыми, или выражение с подстановкой. Вы можете получить статистику по всем трансформациям, используя _all, указав * в качестве <transform_id>, или опуская <transform_id>.

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

<transform_id>
(Необязательно, строка) Идентификатор трансформации. Может быть идентификатором трансформации или выражением с подстановкой. Если вы не укажете ни одно из этих опций, API вернёт информацию обо всех трансформациях.

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

allow_no_match

(Необязательно, булево значение) Указывает, что делать, когда запрос:

  • Содержит выражения с подстановкой, и нет соответствующих трансформаций.
  • Содержит строку _all или нет идентификаторов, и нет совпадений.
  • Содержит выражения с подстановкой и есть только частичные совпадения.

Значение по умолчанию — true, которое возвращает пустой массив transforms, когда нет совпадений, и подмножество результатов, когда есть частичные совпадения.

Если этот параметр равен false, запрос возвращает код состояния 404, когда нет совпадений или только частичные совпадения.

from
(Необязательно, целое число) Пропускает указанное количество трансформаций. Значение по умолчанию — 0.
size
(Необязательно, целое число) Указывает максимальное количество трансформаций для получения. Значение по умолчанию — 100.

Тело ответа

API возвращает массив объектов статистики для преобразований, отсортированных по значению id в порядке возрастания. Все эти свойства являются информационными; вы не можете обновить их значения.

checkpointing

(объект) Содержит статистику о контрольных точках.

Свойства checkpointing
changes_last_detected_at
(дата) Отметка времени последнего обнаружения изменений в исходных индексах.
last

(объект) Содержит статистику о последней завершенной контрольной точке.

Свойства last
checkpoint
(целое число) Номер последовательности контрольной точки.
time_upper_bound_millis
(дата) При использовании синхронизации по времени эта отметка времени указывает верхнюю границу данных, включенных в контрольную точку.
timestamp_millis
(дата) Отметка времени контрольной точки, которая указывает, когда была создана контрольная точка.
last_search_time
(дата) Отметка времени последнего поиска в исходных индексах. Это поле отображается только если преобразование выполняется.
next

(объект) Содержит статистику о следующей контрольной точке, которая в настоящее время выполняется. Этот объект отображается только тогда, когда преобразование state находится в состоянии indexing.

Свойства next
checkpoint
(целое число) Номер последовательности контрольной точки.
checkpoint_progress
(объект) Содержит статистику о ходе выполнения контрольной точки. Например, он перечисляет total_docs, docs_remaining, percent_complete, docs_processed и docs_indexed. Эта информация доступна только для пакетных преобразований и первой контрольной точки непрерывных преобразований.
time_upper_bound_millis
(дата) При использовании синхронизации по времени эта отметка времени указывает верхнюю границу данных, включенных в контрольную точку.
timestamp_millis
(дата) Отметка времени контрольной точки, которая указывает, когда была создана контрольная точка.
operations_behind
(целое число) Количество операций, произошедших в исходном индексе, но еще не примененных к целевому индексу. Большое значение может указывать на то, что преобразование не успевает за обновлениями.
id
(строка) Идентификатор преобразования.
node

(объект) Только для запущенных преобразований, узел, на котором начато преобразование.

Свойства node
attributes
(объект) Список атрибутов для узла.
ephemeral_id
(строка) Временный идентификатор узла.
id
(строка) Уникальный идентификатор узла. Например, "0-o0tOoRTwKFZifatTWKNw".
name
(строка) Имя узла. Например, 0-o0tOo.
transport_address
(строка) Хост и порт, где принимаются транспортные HTTP-соединения. Например, 127.0.0.1:9300.
reason
(строка) Если у преобразования состояние failed, это свойство предоставляет подробности о причине ошибки.
state

(строка) Состояние преобразования, которое может принимать следующие значения:

  • aborting: Преобразование прерывается.
  • failed: Преобразование завершилось ошибкой. Дополнительную информацию об ошибке см. в поле reason.
  • indexing: Преобразование активно обрабатывает данные и создаёт новые документы.
  • started: Преобразование работает, но не индексирует данные активно.
  • stopped: Преобразование остановлено.
  • stopping: Преобразование останавливается.
stats

(объект) Объект, предоставляющий статистическую информацию о преобразовании.

Свойства stats
delete_time_in_ms
(длинное целое число) Время, потраченное на удаление, в миллисекундах.
documents_deleted
(длинное целое число) Количество документов, удаленных из целевого индекса из-за политики хранения для этого преобразования.
documents_indexed
(длинное целое число) Количество документов, индексированных в целевой индекс для преобразования.
documents_processed
(длинное целое число) Количество документов, обработанных из исходного индекса преобразования.
exponential_avg_checkpoint_duration_ms
(двойное число) Экспоненциально скользящее среднее длительности контрольной точки в миллисекундах.
exponential_avg_documents_indexed
(двойное число) Экспоненциально скользящее среднее количества новых индексированных документов.
exponential_avg_documents_processed
(двойное число) Экспоненциально скользящее среднее количества обработанных документов.
index_failures
(длинное целое число) Количество сбоев индексирования.
index_time_in_ms
(длинное целое число) Время, потраченное на индексирование, в миллисекундах.
index_total
(длинное целое число) Количество операций индексации.
pages_processed
(длинное целое число) Количество обработанных операций поиска или массовой индексации. Документы обрабатываются партиями, а не по одному.
processing_time_in_ms
(длинное целое число) Время, потраченное на обработку результатов, в миллисекундах.
processing_total
(длинное целое число) Количество операций обработки.
search_failures
(длинное целое число) Количество сбоев поиска.
search_time_in_ms
(длинное целое число) Время, потраченное на поиск, в миллисекундах.
search_total
(длинное целое число) Количество операций поиска в исходном индексе для преобразования.
trigger_count
(длинное целое число) Количество раз, когда преобразование запускалось планировщиком. Например, планировщик запускает индексатор преобразования для проверки обновлений или загрузки новых данных с интервалом, указанным в frequency свойстве.

Коды ответов

404 (Отсутствуют ресурсы)
Если allow_no_match имеет состояние false, этот код указывает, что ресурсов, соответствующих запросу, нет или есть только частичные соответствия.

Примеры

Следующий пример пропускает первые пять преобразований и получает информацию об использовании для максимального количества десяти результатов:

GET _transform/_stats?from=5&size=10

Следующий пример получает информацию об использовании для преобразования:

GET _transform/ecommerce-customer-transform/_stats

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

{
  "count" : 1,
  "transforms" : [
    {
      "id" : "ecommerce-customer-transform",
      "state" : "started",
      "node" : {
        "id" : "cpTIGMsVQ8Gqwqlxxxxxxx",
        "name" : "my.home",
        "ephemeral_id" : "5-L21nFsQxxxxxxxxxx-xx",
        "transport_address" : "127.0.0.1:9300",
        "attributes" : { }
      },
      "stats" : {
        "pages_processed" : 78,
        "documents_processed" : 6027,
        "documents_indexed" : 68,
        "documents_deleted": 22,
        "delete_time_in_ms": 214,
        "trigger_count" : 168,
        "index_time_in_ms" : 412,
        "index_total" : 20,
        "index_failures" : 0,
        "search_time_in_ms" : 353,
        "search_total" : 78,
        "search_failures" : 0,
        "processing_time_in_ms" : 8,
        "processing_total" : 78,
        "exponential_avg_checkpoint_duration_ms" : 97.30637923893185,
        "exponential_avg_documents_indexed" : 2.2064915040974062,
        "exponential_avg_documents_processed" : 179.89419945785045
      },
      "checkpointing" : {
        "last" : {
          "checkpoint" : 20,
          "timestamp_millis" : 1585344558220,
          "time_upper_bound_millis" : 1585344498220
        },
        "changes_last_detected_at" : 1585344558219
      }
    }
  ]
}

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API