获取 Follower 统计信息 API

编辑

获取 跨集群复制 Follower 统计信息。

请求

编辑
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 安全功能,则必须在包含 Follower 索引的集群上拥有 monitor 集群权限。有关更多信息,请参阅 安全权限

描述

编辑

此 API 获取 Follower 统计信息。此 API 将返回有关指定索引的每个分片上与以下任务关联的分片级统计信息。

路径参数

编辑
<index>
(必填,字符串) 索引模式的逗号分隔列表。

查询参数

编辑
timeout
(可选,时间) 控制等待结果的时间。默认为无限。

响应主体

编辑
indices

(数组) Follower 索引统计信息的数组。

indices 的属性
fatal_exception
(对象) 表示取消跟随任务的致命异常的对象。在这种情况下,必须使用 恢复 Follower API 手动恢复跟随任务。
index
(字符串) Follower 索引的名称。
total_global_checkpoint_lag
(长整型) 指示 Follower 落后于 Leader 的程度。这是所有分片的 leader_global_checkpointfollower_global_checkpoint 之差的总和。
shards

(数组) 分片级跟随任务统计信息的数组。

shards 中对象的属性
bytes_read

(长整型) 从 Leader 读取的传输字节总数。

这只是一个估计值,如果启用了压缩,则不考虑压缩。

failed_read_requests
(长整型) 失败读取的次数。
failed_write_requests
(长整型) 在 Follower 上执行的失败批量写入请求的次数。
follower_aliases_version
(长整型) Follower 同步到的索引别名版本。
follower_global_checkpoint
(长整型) Follower 上的当前全局检查点。 leader_global_checkpointfollower_global_checkpoint 之差表示 Follower 落后于 Leader 的程度。
follower_index
(字符串) Follower 索引的名称。
follower_mapping_version
(长整型) Follower 同步到的映射版本。
follower_max_seq_no
(长整型) Follower 上的当前最大序列号。
follower_settings_version
(长整型) Follower 同步到的索引设置版本。
last_requested_seq_no
(长整型) 从 Leader 请求的最后一批操作的起始序列号。
leader_global_checkpoint
(长整型) Follower 任务已知的 Leader 上的当前全局检查点。
leader_index
(字符串) 正在跟随的 Leader 集群中索引的名称。
leader_max_seq_no
(长整型) Follower 任务已知的 Leader 上的当前最大序列号。
operations_read
(长整型) 从 Leader 读取的操作总数。
operations_written
(长整型) 在 Follower 上写入的操作数。
outstanding_read_requests
(整数) Follower 的活动读取请求数。
outstanding_write_requests
(整数) Follower 上的活动批量写入请求数。
read_exceptions

(数组) 表示失败读取的对象数组。

read_exceptions 中对象的属性
exception
(对象) 表示导致读取失败的异常。
from_seq_no
(长整型) 从 Leader 请求的批次的起始序列号。
retries
(整数) 批次重试的次数。
remote_cluster
(字符串) 包含 Leader 索引的 远程集群
shard_id
(整数) 分片的数字 ID,取值范围为 0 到副本数减 1。
successful_read_requests
(长整型) 成功提取的次数。
successful_write_requests
(长整型) 在 Follower 上执行的批量写入请求的次数。
time_since_last_read_millis

(长整型) 自上次向 Leader 发送读取请求以来经过的毫秒数。

当 Follower 追赶上 Leader 时,此数字将增加到配置的 read_poll_timeout,此时将向 Leader 发送另一个读取请求。

total_read_remote_exec_time_millis
(长整型) 读取在远程集群上执行花费的总时间。
total_read_time_millis
(长整型) 读取处于挂起状态的总时间,从向 Leader 发送读取请求到 Follower 返回回复的时间进行测量。
total_write_time_millis
(长整型) 在 Follower 上写入花费的总时间。
write_buffer_operation_count
(整数) 在 Follower 上排队的写入操作数。
write_buffer_size_in_bytes
(长整型) 当前排队等待写入的操作的总字节数。

示例

编辑

此示例检索 Follower 统计信息

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
        }
      ]
    }
  ]
}