Spec-Zone.ru › Elasticsearch 8
›Руководство по Elasticsearch [8.17] ›REST API ›API трансформирования

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

Справочник нового 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
(целое число) Количество операций, произошедших в исходном индексе, но ещё не применённых к целевому индексу. Большое значение может указывать на то, что преобразование не успевает обрабатывать данные.
health

(объект) Индикатор состояния работоспособности этого преобразования.

Свойства health
status

(строка) Статус работоспособности этого преобразования. Статусы:

  • green: Преобразование работает нормально.
  • unknown: Состояние работоспособности преобразования определить не удалось.
  • yellow: Функциональность преобразования находится в ухудшенном состоянии и, возможно, требует исправления, чтобы избежать перехода в состояние red.
  • red: Преобразование испытывает перебои или недоступно для использования.
issues

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

Свойства issues
issue
(строка) Описание проблемы.
details
(Необязательная строка) Подробности о проблеме.
count
(целое число) Количество раз, когда проблема возникла с момента её начала.
first_occurrence
(Необязательная дата) Отметка времени первого возникновения этой проблемы.
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, этот код указывает на отсутствие ресурсов, соответствующих запросу, или частичное соответствие запросу.

Примеры

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

resp = client.transform.get_transform(
    transform_id="_stats",
    from_="5",
    size="10",
)
print(resp)
response = client.transform.get_transform(
  transform_id: '_stats',
  from: 5,
  size: 10
)
puts response
const response = await client.transform.getTransform({
  transform_id: "_stats",
  from: 5,
  size: 10,
});
console.log(response);
GET _transform/_stats?from=5&size=10

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

resp = client.transform.get_transform_stats(
    transform_id="ecommerce-customer-transform",
)
print(resp)
response = client.transform.get_transform_stats(
  transform_id: 'ecommerce-customer-transform'
)
puts response
const response = await client.transform.getTransformStats({
  transform_id: "ecommerce-customer-transform",
});
console.log(response);
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
      },
      "health": {
        "status": "green"
      }
    }
  ]
}

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

Spec-Zone.ru

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