Get cross-cluster replication stats | Elasticsearch API documentation

Query parameters

master_timeoutstring
The period to wait for a connection to the master node. If the master node is not available before the timeout expires, the request fails and returns an error. It can also be set to -1 to indicate that the request should never timeout.
Values are -1 or 0.
timeoutstring
The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error.
Values are -1 or 0.

Responses

200 application/json
Hide response attributes Show response attributes object
- auto_follow_statsobject Required
  Hide auto_follow_stats attributes Show auto_follow_stats attributes object
  auto_followed_clustersarray[object] Required
  Hide auto_followed_clusters attributes Show auto_followed_clusters attributes object
  cluster_namestring Required
  last_seen_metadata_versionnumber Required
  time_since_last_check_millisnumber
  Time unit for milliseconds
  number_of_failed_follow_indicesnumber Required
  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.
  number_of_failed_remote_cluster_state_requestsnumber Required
  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.
  number_of_successful_follow_indicesnumber Required
  The number of indices that the auto-follow coordinator successfully followed.
  recent_auto_follow_errorsarray[object] Required
  An array of objects representing failures by the auto-follow coordinator.
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  Hide recent_auto_follow_errors attributes Show recent_auto_follow_errors attributes object
  typestring Required
  The type of error
  reasonstring | null
  A human-readable explanation of the error, in English.
  One of:
  string-1string string-2string | null
  stack_tracestring
  The server stack trace. Present only if the error_trace=true parameter was sent with the request.
  caused_byobject
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  root_causearray[object]
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  suppressedarray[object]
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
- follow_statsobject Required
  Hide follow_stats attribute Show follow_stats attribute object
  indicesarray[object] Required
  Hide indices attributes Show indices attributes object
  indexstring Required
  shardsarray[object] Required
  An array of shard-level following task statistics.
  Hide shards attributes Show shards attributes object
  bytes_readnumber Required
  The total of transferred bytes read from the leader. This is only an estimate and does not account for compression if enabled.
  failed_read_requestsnumber Required
  The number of failed reads.
  failed_write_requestsnumber Required
  The number of failed bulk write requests on the follower.
  fatal_exceptionobject
  Cause and details about a request failure. This class defines the properties common to all error types. Additional details are also provided, that depend on the error type.
  follower_aliases_versionnumber Required
  follower_global_checkpointnumber Required
  The current global checkpoint on the follower. The difference between the leader_global_checkpoint and the follower_global_checkpoint is an indication of how much the follower is lagging the leader.
  follower_indexstring Required
  The name of the follower index.
  follower_mapping_versionnumber Required
  follower_max_seq_nonumber Required
  follower_settings_versionnumber Required
  last_requested_seq_nonumber Required
  leader_global_checkpointnumber Required
  The current global checkpoint on the leader known to the follower task.
  leader_indexstring Required
  The name of the index in the leader cluster being followed.
  leader_max_seq_nonumber Required
  operations_readnumber Required
  The total number of operations read from the leader.
  operations_writtennumber Required
  The number of operations written on the follower.
  outstanding_read_requestsnumber Required
  The number of active read requests from the follower.
  outstanding_write_requestsnumber Required
  The number of active bulk write requests on the follower.
  read_exceptionsarray[object] Required
  An array of objects representing failed reads.
  remote_clusterstring Required
  The remote cluster containing the leader index.
  shard_idnumber Required
  The numerical shard ID, with values from 0 to one less than the number of replicas.
  successful_read_requestsnumber Required
  The number of successful fetches.
  successful_write_requestsnumber Required
  The number of bulk write requests run on the follower.
  time_since_last_readstring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  time_since_last_read_millis
  total_read_remote_exec_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_read_remote_exec_time_millis
  total_read_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_read_time_millis
  total_write_timestring
  A duration. Units can be nanos, micros, ms (milliseconds), s (seconds), m (minutes), h (hours) and d (days). Also accepts "0" without a unit and "-1" to indicate an unspecified value.
  total_write_time_millis
  write_buffer_operation_countnumber Required
  The number of write operations queued on the follower.
  write_buffer_size_in_bytes

GET /_ccr/stats

GET /_ccr/stats

resp = client.ccr.stats()

const response = await client.ccr.stats();

response = client.ccr.stats

$resp = $client->ccr()->stats();

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

Response examples (200)

A successful response from `GET /_ccr/stats` that returns cross-cluster replication stats.

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

Query parameters

Responses

reasonstring | null