Get follower stats

GET /{index}/_ccr/stats

Get cross-cluster replication follower stats. The API returns shard-level stats about the "following tasks" associated with each shard for the specified indices.

Required authorization

Cluster privileges: monitor

Read the reference documentation

Path Parameters

index union IndexName | [] IndexName required: A comma-delimited list of index patterns.

Query Parameters

timeout string Duration · default: 30s: The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.

Response

application/json

Examples

A successful response from GET /follower_index/_ccr/stats, which retrieves follower stats.

Request Console 1 / 8 languages

Console Kibana Dev Tools

GET /follower_index/_ccr/stats

JavaScript Elasticsearch JavaScript Client

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

Python Elasticsearch Python Client

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

curl Shell

curl -X GET "$ELASTICSEARCH_URL/follower_index/_ccr/stats" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY"

Java Elasticsearch Java Client

client.ccr().followStats(f -> f
    .index("follower_index")
);

C# Elasticsearch .NET Client

var response = await client.CrossClusterReplication.FollowStatsAsync(indices: new[] { "follower_index" });

PHP Elasticsearch PHP Client

$resp = $client->ccr()->followStats([
    "index" => "follower_index",
]);

Ruby Elasticsearch Ruby Client

response = client.ccr.follow_stats(
  index: "follower_index"
)

Response

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