IMPORTANT: No additional bug fixes or documentation updates
will be released for this version. For the latest information, see the
current release documentation.
Get cross-cluster replication stats API
editGet cross-cluster replication stats API
editGet cross-cluster replication stats.
Description
editThis API gets cross-cluster replication stats. This API will return all stats related to cross-cluster replication. In particular, this API returns stats about auto-following, and returns the same shard-level stats as in the get follower stats API.
Request
editGET /_ccr/stats
Results
editThis API returns the following information:
-
auto_follow_stats
- (object) an object representing stats for the auto-follow coordinator
This object consists of the following fields:
-
auto_follow_stats.number_of_failed_follow_indices
-
(long) the number of indices that the auto-follow coordinator failed to
automatically follow; the causes of recent failures are captured in the logs
of the elected master node, and in the
auto_follow_stats.recent_auto_follow_errors
field -
auto_follow_stats.number_of_failed_remote_cluster_state_requests
- (long) the number of times that the auto-follow coordinator failed to retrieve the cluster state from a remote cluster registered in a collection of auto-follow patterns
-
auto_follow_stats.number_of_successful_follow_indices
- (long) the number of indices that the auto-follow coordinator successfully followed
-
auto_follow_stats.recent_auto_follow_errors
- (array) an array of objects representing failures by the auto-follow coordinator
-
follow_stats
- (object) an object representing shard-level stats for follower indices; refer to the details of the response in the get follower stats API
Authorization
editIf the Elasticsearch security features are enabled, you must have monitor
cluster
privileges on the cluster that contains the follower index. For more information,
see Security privileges.
Example
editThis example retrieves cross-cluster replication stats:
GET /_ccr/stats
The API returns the following results:
{ "auto_follow_stats" : { "number_of_failed_follow_indices" : 0, "number_of_failed_remote_cluster_state_requests" : 0, "number_of_successful_follow_indices" : 1, "recent_auto_follow_errors" : [], "auto_followed_clusters" : [] }, "follow_stats" : { "indices" : [ { "index" : "follower_index", "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, "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 } ] } ] } }