› › ›

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

Получить статистику фолловера кросс-кластерной репликации.

Запрос

resp = client.ccr.follow_stats(
    index="<index>",
)
print(resp)

const response = await client.ccr.followStats({
  index: "<index>",
});
console.log(response);

GET /<index>/_ccr/stats

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

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

Описание

Этот API получает статистику фолловера. Этот API вернёт статистику на уровне фрагментов о следующих задачах, связанных с каждым фрагментом для указанных индексов.

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

<index>: (Обязательно, строка) Список индексных шаблонов, разделённых запятыми.

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

timeout: (Необязательно, время) Управляет временем ожидания результатов. По умолчанию — неограниченное.

Тело ответа

indices

(массив) Массив статистических данных индексов фолловера.

Свойства indices

fatal_exception: (объект) Объект, представляющий фатальную ошибку, которая отменила задачу фолловера. В этой ситуации задачу фолловера нужно возобновить вручную с помощью API возобновления фолловера.
index: (строка) Имя индекса фолловера.
total_global_checkpoint_lag: (целое число) Показатель отставания фолловера от лидера. Это сумма разницы между leader_global_checkpoint и follower_global_checkpoint для всех фрагментов.

shards

(массив) Массив статистических данных задачи фолловера на уровне фрагмента.

Свойства объектов в shards

bytes_read: (целое число) Общий объём переданных байтов, прочитанных с лидера.

Это лишь оценка и не учитывает сжатие, если оно включено.
failed_read_requests: (целое число) Количество неудачных чтений.
failed_write_requests: (целое число) Количество неудачных запросов пакетной записи, выполненных на фоллoвере.
follower_aliases_version: (целое число) Версия алиасов индекса, до которой синхронизирован фоллoвер.
follower_global_checkpoint: (целое число) Текущая глобальная контрольная точка на фоллoвере. Разница между leader_global_checkpoint и follower_global_checkpoint показывает, насколько фоллoвер отстаёт от лидера.
follower_index: (строка) Имя индекса фолловера.
follower_mapping_version: (целое число) Версия отображения, до которой синхронизирован фоллoвер.
follower_max_seq_no: (целое число) Текущее максимальное значение порядкового номера на фоллoвере.
follower_settings_version: (целое число) Версия настроек индекса, до которой синхронизирован фоллoвер.
last_requested_seq_no: (целое число) Начальный порядковый номер последней партии операций, запрошенных у лидера.
leader_global_checkpoint: (целое число) Текущая глобальная контрольная точка на лидере, известная задаче фолловера.
leader_index: (строка) Имя индекса в кластере лидера, за которым ведётся слежение.
leader_max_seq_no: (целое число) Текущее максимальное значение порядкового номера на лидере, известное задаче фолловера.
operations_read: (целое число) Общее количество операций, прочитанных с лидера.
operations_written: (целое число) Количество операций, записанных на фоллoвере.
outstanding_read_requests: (целое число) Количество активных запросов чтения с фолловера.
outstanding_write_requests: (целое число) Количество активных запросов пакетной записи на фоллoвере.

read_exceptions

(массив) Массив объектов, представляющих неудачные чтения.

Свойства объектов в read_exceptions

exception: (объект) Представляет исключение, из-за которого чтение не удалось.
from_seq_no: (целое число) Начальный порядковый номер партии, запрошенной у лидера.
retries: (целое число) Количество попыток повторной обработки партии.

remote_cluster

(строка) Удаленный кластер, содержащий индекс лидера.

shard_id

(целое число) Номер фрагмента, от 0 до значения на единицу меньше количества реплик.

successful_read_requests

(целое число) Количество успешных извлечений.

successful_write_requests

(целое число) Количество выполненных запросов пакетной записи на фоллoвере.

time_since_last_read_millis

(целое число) Количество миллисекунд, прошедших с момента отправки запроса чтения лидера.

Когда фоллoвер догонит лидера, это число увеличится до значения read_poll_timeout, после чего будет отправлен ещё один запрос чтения лидера.

total_read_remote_exec_time_millis

(целое число) Общее время выполнения чтений в удалённом кластере.

total_read_time_millis

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

total_write_time_millis

(целое число) Общее время, затраченное на запись на фоллoвере.

write_buffer_operation_count

(целое число) Количество операций записи, помещенных в очередь на фоллoвере.

write_buffer_size_in_bytes

(целое число) Общий объём байтов операций, в настоящее время помещенных в очередь для записи.

Примеры

В этом примере извлекается статистика фолловера:

resp = client.ccr.follow_stats(
    index="follower_index",
)
print(resp)

const response = await client.ccr.followStats({
  index: "follower_index",
});
console.log(response);

GET /follower_index/_ccr/stats

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

{
  "indices" : [
    {
      "index" : "follower_index",
      "total_global_checkpoint_lag" : 256,
      "shards" : [
        {
          "remote_cluster" : "remote_cluster",
          "leader_index" : "leader_index",
          "follower_index" : "follower_index",
          "shard_id" : 0,
          "leader_global_checkpoint" : 1024,
          "leader_max_seq_no" : 1536,
          "follower_global_checkpoint" : 768,
          "follower_max_seq_no" : 896,
          "last_requested_seq_no" : 897,
          "outstanding_read_requests" : 8,
          "outstanding_write_requests" : 2,
          "write_buffer_operation_count" : 64,
          "follower_mapping_version" : 4,
          "follower_settings_version" : 2,
          "follower_aliases_version" : 8,
          "total_read_time_millis" : 32768,
          "total_read_remote_exec_time_millis" : 16384,
          "successful_read_requests" : 32,
          "failed_read_requests" : 0,
          "operations_read" : 896,
          "bytes_read" : 32768,
          "total_write_time_millis" : 16384,
          "write_buffer_size_in_bytes" : 1536,
          "successful_write_requests" : 16,
          "failed_write_requests" : 0,
          "operations_written" : 832,
          "read_exceptions" : [ ],
          "time_since_last_read_millis" : 8
        }
      ]
    }
  ]
}

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