[DOCS] Collapse nested objects in CCR APIs (#54697)
This commit is contained in:
Lisa Cawley
lcawl
parent
022f829d84
commit
de91d2aeea
|
|
@ -57,77 +57,84 @@ replication options and whether the follower indices are active or paused.
|
||||||
`<index>`::
|
`<index>`::
|
||||||
(Required, string) A comma-delimited list of follower index patterns.
|
(Required, string) A comma-delimited list of follower index patterns.
|
||||||
|
|
||||||
|
[role="child_attributes"]
|
||||||
[[ccr-get-follow-info-response-body]]
|
[[ccr-get-follow-info-response-body]]
|
||||||
==== {api-response-body-title}
|
==== {api-response-body-title}
|
||||||
|
|
||||||
This API returns the following information:
|
//Begin follower_indices
|
||||||
|
|
||||||
`follower_indices`::
|
`follower_indices`::
|
||||||
(array) An array of follower index statistics.
|
(array) An array of follower index statistics.
|
||||||
|
+
|
||||||
|
.Properties of objects in `follower_indices`
|
||||||
|
[%collapsible%open]
|
||||||
|
====
|
||||||
|
`follower_index`::
|
||||||
|
(string) The name of the follower index.
|
||||||
|
|
||||||
The `indices` array consists of objects containing several fields:
|
`leader_index`::
|
||||||
|
(string) The name of the index in the leader cluster that is followed.
|
||||||
|
|
||||||
`indices[].follower_index`::
|
//Begin parameters
|
||||||
(string) The name of the follower index.
|
`parameters`::
|
||||||
|
(object) An object that encapsulates {ccr} parameters.
|
||||||
|
+
|
||||||
|
.Properties of `parameters`
|
||||||
|
[%collapsible%open]
|
||||||
|
=====
|
||||||
|
`max_outstanding_read_requests`::
|
||||||
|
(long) The maximum number of outstanding read requests from the remote cluster.
|
||||||
|
|
||||||
`indices[].remote_cluster`::
|
`max_outstanding_write_requests`::
|
||||||
(string) The <<modules-remote-clusters,remote cluster>> that contains the
|
(integer) The maximum number of outstanding write requests on the follower.
|
||||||
leader index.
|
|
||||||
|
|
||||||
`indices[].leader_index`::
|
`max_read_request_operation_count`::
|
||||||
(string) The name of the index in the leader cluster that is followed.
|
(integer) The maximum number of operations to pull per read from the remote
|
||||||
|
cluster.
|
||||||
|
|
||||||
`indices[].status`::
|
`max_read_request_size`::
|
||||||
(string) Whether index following is `active` or `paused`.
|
(<<byte-units,byte value>>) The maximum size in bytes of per read of a batch of
|
||||||
|
operations pulled from the remote cluster.
|
||||||
|
|
||||||
`indices[].parameters`::
|
`max_retry_delay`::
|
||||||
(object) An object that encapsulates {ccr} parameters.
|
(<<time-units,time value>>) The maximum time to wait before retrying an
|
||||||
|
operation that failed exceptionally. An exponential backoff strategy is employed
|
||||||
|
when retrying.
|
||||||
|
|
||||||
The `parameters` contains the following fields:
|
`max_write_buffer_count`::
|
||||||
|
(integer) The maximum number of operations that can be queued for writing. When
|
||||||
|
this limit is reached, reads from the remote cluster are deferred until the
|
||||||
|
number of queued operations goes below the limit.
|
||||||
|
|
||||||
`indices[].parameters.max_read_request_operation_count`::
|
`max_write_buffer_size`::
|
||||||
(integer) The maximum number of operations to pull per read from the remote
|
(<<byte-units,byte value>>) The maximum total bytes of operations that can be
|
||||||
cluster.
|
queued for writing. When this limit is reached, reads from the remote cluster
|
||||||
|
are deferred until the total bytes of queued operations goes below the limit.
|
||||||
|
|
||||||
`indices[].parameters.max_outstanding_read_requests`::
|
`max_write_request_operation_count`::
|
||||||
(long) The maximum number of outstanding read requests from the remote cluster.
|
(integer) The maximum number of operations per bulk write request executed on
|
||||||
|
the follower.
|
||||||
|
|
||||||
`indices[].parameters.max_read_request_size`::
|
`max_write_request_size`::
|
||||||
(<<byte-units,byte value>>) The maximum size in bytes of per read of a batch
|
(<<byte-units,byte value>>) The maximum total bytes of operations per bulk write
|
||||||
of operations pulled from the remote cluster.
|
request executed on the follower.
|
||||||
|
|
||||||
`indices[].parameters.max_write_request_operation_count`::
|
`read_poll_timeout`::
|
||||||
(integer) The maximum number of operations per bulk write request executed on
|
(<<time-units,time value>>) The maximum time to wait for new operations on the
|
||||||
the follower.
|
remote cluster when the follower index is synchronized with the leader index.
|
||||||
|
When the timeout has elapsed, the poll for operations returns to the follower so
|
||||||
|
that it can update some statistics, then the follower immediately attempts
|
||||||
|
to read from the leader again.
|
||||||
|
=====
|
||||||
|
//End parameters
|
||||||
|
|
||||||
`indices[].parameters.max_write_request_size`::
|
`remote_cluster`::
|
||||||
(<<byte-units,byte value>>) The maximum total bytes of operations per bulk
|
(string) The <<modules-remote-clusters,remote cluster>> that contains the
|
||||||
write request executed on the follower.
|
leader index.
|
||||||
|
|
||||||
`indices[].parameters.max_outstanding_write_requests`::
|
`status`::
|
||||||
(integer) The maximum number of outstanding write requests on the follower.
|
(string) Whether index following is `active` or `paused`.
|
||||||
|
====
|
||||||
`indices[].parameters.max_write_buffer_count`::
|
//End follower_indices
|
||||||
(integer) The maximum number of operations that can be queued for writing.
|
|
||||||
When this limit is reached, reads from the remote cluster are deferred until
|
|
||||||
the number of queued operations goes below the limit.
|
|
||||||
|
|
||||||
`indices[].parameters.max_write_buffer_size`::
|
|
||||||
(<<byte-units,byte value>>) The maximum total bytes of operations that can be
|
|
||||||
queued for writing. When this limit is reached, reads from the remote cluster
|
|
||||||
are deferred until the total bytes of queued operations goes below the limit.
|
|
||||||
|
|
||||||
`indices[].parameters.max_retry_delay`::
|
|
||||||
(<<time-units,time value>>) The maximum time to wait before retrying an
|
|
||||||
operation that failed exceptionally. An exponential backoff strategy is
|
|
||||||
employed when retrying.
|
|
||||||
|
|
||||||
`indices[].parameters.read_poll_timeout`::
|
|
||||||
(<<time-units,time value>>) The maximum time to wait for new operations on the
|
|
||||||
remote cluster when the follower index is synchronized with the leader index.
|
|
||||||
When the timeout has elapsed, the poll for operations returns to the follower
|
|
||||||
so that it can update some statistics, then the follower immediately attempts
|
|
||||||
to read from the leader again.
|
|
||||||
|
|
||||||
[[ccr-get-follow-info-examples]]
|
[[ccr-get-follow-info-examples]]
|
||||||
==== {api-examples-title}
|
==== {api-examples-title}
|
||||||
|
|
|
||||||
|
|
@ -57,145 +57,150 @@ following tasks associated with each shard for the specified indices.
|
||||||
`<index>`::
|
`<index>`::
|
||||||
(Required, string) A comma-delimited list of index patterns.
|
(Required, string) A comma-delimited list of index patterns.
|
||||||
|
|
||||||
|
[role="child_attributes"]
|
||||||
[[ccr-get-follow-stats-response-body]]
|
[[ccr-get-follow-stats-response-body]]
|
||||||
==== {api-response-body-title}
|
==== {api-response-body-title}
|
||||||
|
|
||||||
This API returns the following information:
|
//Begin indices
|
||||||
|
|
||||||
`indices`::
|
`indices`::
|
||||||
(array) An array of follower index statistics.
|
(array) An array of follower index statistics.
|
||||||
|
+
|
||||||
|
.Properties of `indices`
|
||||||
|
[%collapsible%open]
|
||||||
|
====
|
||||||
|
`fatal_exception`::
|
||||||
|
(object) An object representing a fatal exception that cancelled the following
|
||||||
|
task. In this situation, the following task must be resumed manually with the
|
||||||
|
<<ccr-post-resume-follow,resume follower API>>.
|
||||||
|
|
||||||
The `indices` array consists of objects containing two fields:
|
`index`::
|
||||||
|
(string) The name of the follower index.
|
||||||
|
|
||||||
`indices[].index`::
|
//Begin shards
|
||||||
(string) The name of the follower index.
|
`shards`::
|
||||||
|
(array) An array of shard-level following task statistics.
|
||||||
`indices[].shards`::
|
+
|
||||||
(array) An array of shard-level following task statistics.
|
.Properties of objects in `shards`
|
||||||
|
[%collapsible%open]
|
||||||
The `shards` array consists of objects containing the following fields:
|
=====
|
||||||
|
`bytes_read`::
|
||||||
`indices[].shards[].remote_cluster`::
|
(long) The total of transferred bytes read from the leader.
|
||||||
(string) The <<modules-remote-clusters,remote cluster>> containing the leader
|
|
||||||
index.
|
|
||||||
|
|
||||||
`indices[].shards[].leader_index`::
|
|
||||||
(string) The name of the index in the leader cluster being followed.
|
|
||||||
|
|
||||||
`indices[].shards[].follower_index`::
|
|
||||||
(string) The name of the follower index.
|
|
||||||
|
|
||||||
`indices[].shards[].shard_id`::
|
|
||||||
(integer) The numerical shard ID, with values from 0 to one less than the
|
|
||||||
number of replicas.
|
|
||||||
|
|
||||||
`indices[].shards[].leader_global_checkpoint`::
|
|
||||||
(long) The current global checkpoint on the leader known to the follower task.
|
|
||||||
|
|
||||||
`indices[].shards[].leader_max_seq_no`::
|
|
||||||
(long) The current maximum sequence number on the leader known to the follower
|
|
||||||
task.
|
|
||||||
|
|
||||||
`indices[].shards[].follower_global_checkpoint`::
|
|
||||||
(long) 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.
|
|
||||||
|
|
||||||
`indices[].shards[].follower_max_seq_no`::
|
|
||||||
(long) The current maximum sequence number on the follower.
|
|
||||||
|
|
||||||
`indices[].shards[].last_requested_seq_no`::
|
|
||||||
(long) The starting sequence number of the last batch of operations requested
|
|
||||||
from the leader.
|
|
||||||
|
|
||||||
`indices[].shards[].outstanding_read_requests`::
|
|
||||||
(integer) The number of active read requests from the follower.
|
|
||||||
|
|
||||||
`indices[].shards[].outstanding_write_requests`::
|
|
||||||
(integer) The number of active bulk write requests on the follower.
|
|
||||||
|
|
||||||
`indices[].shards[].write_buffer_operation_count`::
|
|
||||||
(integer) The number of write operations queued on the follower.
|
|
||||||
|
|
||||||
`indices[].shards[].follower_mapping_version`::
|
|
||||||
(long) The mapping version the follower is synced up to.
|
|
||||||
|
|
||||||
`indices[].shards[].follower_settings_version`::
|
|
||||||
(long) The index settings version the follower is synced up to.
|
|
||||||
|
|
||||||
`indices[].shards[].follower_aliases_version`::
|
|
||||||
(long) The index aliases version the follower is synced up to.
|
|
||||||
|
|
||||||
`indices[].shards[].total_read_time_millis`::
|
|
||||||
(long) The total time reads were outstanding, measured from the time a read
|
|
||||||
was sent to the leader to the time a reply was returned to the follower.
|
|
||||||
|
|
||||||
`indices[].shards[].total_read_remote_exec_time_millis`::
|
|
||||||
(long) The total time reads spent executing on the remote cluster.
|
|
||||||
|
|
||||||
`indices[].shards[].successful_read_requests`::
|
|
||||||
(long) The number of successful fetches.
|
|
||||||
|
|
||||||
`indices[].shards[].failed_read_requests`::
|
|
||||||
(long) The number of failed reads.
|
|
||||||
|
|
||||||
`indices[].shards[].operations_read`::
|
|
||||||
(long) The total number of operations read from the leader.
|
|
||||||
|
|
||||||
`indices[].shards[].bytes_read`::
|
|
||||||
(long) The total of transferred bytes read from the leader.
|
|
||||||
+
|
+
|
||||||
--
|
--
|
||||||
NOTE: This is only an estimate and does not account for compression if enabled.
|
NOTE: This is only an estimate and does not account for compression if enabled.
|
||||||
|
|
||||||
--
|
--
|
||||||
|
|
||||||
`indices[].shards[].total_write_time_millis`::
|
`failed_read_requests`::
|
||||||
(long) The total time spent writing on the follower.
|
(long) The number of failed reads.
|
||||||
|
|
||||||
`indices[].shards[].write_buffer_size_in_bytes`::
|
failed_write_requests`::
|
||||||
(long) The total number of bytes of operations currently queued for writing.
|
(long) The number of failed bulk write requests executed on the follower.
|
||||||
|
|
||||||
`indices[].shards[].successful_write_requests`::
|
`follower_aliases_version`::
|
||||||
(long) The number of bulk write requests executed on the follower.
|
(long) The index aliases version the follower is synced up to.
|
||||||
|
|
||||||
`indices[].shards[].failed_write_requests`::
|
`follower_global_checkpoint`::
|
||||||
(long) The number of failed bulk write requests executed on the follower.
|
(long) 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.
|
||||||
|
|
||||||
`indices[].shards[].operations_written`::
|
`follower_index`::
|
||||||
(long) The number of operations written on the follower.
|
(string) The name of the follower index.
|
||||||
|
|
||||||
`indices[].shards[].read_exceptions`::
|
`follower_mapping_version`::
|
||||||
(array) An array of objects representing failed reads.
|
(long) The mapping version the follower is synced up to.
|
||||||
|
|
||||||
The `read_exceptions` array consists of objects containing the following
|
`follower_max_seq_no`::
|
||||||
fields:
|
(long) The current maximum sequence number on the follower.
|
||||||
|
|
||||||
`indices[].shards[].read_exceptions[].from_seq_no`::
|
`follower_settings_version`::
|
||||||
(long) The starting sequence number of the batch requested from the leader.
|
(long) The index settings version the follower is synced up to.
|
||||||
|
|
||||||
`indices[].shards[].read_exceptions[].retries`::
|
`last_requested_seq_no`::
|
||||||
(integer) The number of times the batch has been retried.
|
(long) The starting sequence number of the last batch of operations requested
|
||||||
|
from the leader.
|
||||||
|
|
||||||
`indices[].shards[].read_exceptions[].exception`::
|
`leader_global_checkpoint`::
|
||||||
(object) Represents the exception that caused the read to fail.
|
(long) The current global checkpoint on the leader known to the follower task.
|
||||||
|
|
||||||
Continuing with the fields from `shards`:
|
`leader_index`::
|
||||||
|
(string) The name of the index in the leader cluster being followed.
|
||||||
|
|
||||||
`indices[].shards[].time_since_last_read_millis`::
|
`leader_max_seq_no`::
|
||||||
(long) The number of milliseconds since a read request was sent to the leader.
|
(long) The current maximum sequence number on the leader known to the follower
|
||||||
|
task.
|
||||||
|
|
||||||
|
`operations_read`::
|
||||||
|
(long) The total number of operations read from the leader.
|
||||||
|
|
||||||
|
operations_written`::
|
||||||
|
(long) The number of operations written on the follower.
|
||||||
|
|
||||||
|
`outstanding_read_requests`::
|
||||||
|
(integer) The number of active read requests from the follower.
|
||||||
|
|
||||||
|
`outstanding_write_requests`::
|
||||||
|
(integer) The number of active bulk write requests on the follower.
|
||||||
|
|
||||||
|
//Begin read_exceptions
|
||||||
|
`read_exceptions`::
|
||||||
|
(array) An array of objects representing failed reads.
|
||||||
+
|
+
|
||||||
--
|
.Properties of objects in `read_exceptions`
|
||||||
NOTE: When the follower is caught up to the leader, this number will
|
[%collapsible%open]
|
||||||
increase up to the configured `read_poll_timeout` at which point another read
|
======
|
||||||
request will be sent to the leader.
|
`exception`::
|
||||||
|
(object) Represents the exception that caused the read to fail.
|
||||||
|
|
||||||
--
|
`from_seq_no`::
|
||||||
|
(long) The starting sequence number of the batch requested from the leader.
|
||||||
|
|
||||||
`indices[].fatal_exception`::
|
`retries`::
|
||||||
(object) An object representing a fatal exception that cancelled the following
|
(integer) The number of times the batch has been retried.
|
||||||
task. In this situation, the following task must be resumed manually with the
|
======
|
||||||
<<ccr-post-resume-follow,resume follower API>>.
|
//End read_exceptions
|
||||||
|
|
||||||
|
`remote_cluster`::
|
||||||
|
(string) The <<modules-remote-clusters,remote cluster>> containing the leader
|
||||||
|
index.
|
||||||
|
|
||||||
|
`shard_id`::
|
||||||
|
(integer) The numerical shard ID, with values from 0 to one less than the
|
||||||
|
number of replicas.
|
||||||
|
|
||||||
|
`successful_read_requests`::
|
||||||
|
(long) The number of successful fetches.
|
||||||
|
|
||||||
|
`successful_write_requests`::
|
||||||
|
(long) The number of bulk write requests executed on the follower.
|
||||||
|
|
||||||
|
`time_since_last_read_millis`::
|
||||||
|
(long) The number of milliseconds since a read request was sent to the leader.
|
||||||
|
+
|
||||||
|
NOTE: When the follower is caught up to the leader, this number will increase up
|
||||||
|
to the configured `read_poll_timeout` at which point another read request will
|
||||||
|
be sent to the leader.
|
||||||
|
|
||||||
|
`total_read_remote_exec_time_millis`::
|
||||||
|
(long) The total time reads spent executing on the remote cluster.
|
||||||
|
|
||||||
|
`total_read_time_millis`::
|
||||||
|
(long) The total time reads were outstanding, measured from the time a read was
|
||||||
|
sent to the leader to the time a reply was returned to the follower.
|
||||||
|
|
||||||
|
`total_write_time_millis`::
|
||||||
|
(long) The total time spent writing on the follower.
|
||||||
|
|
||||||
|
`write_buffer_operation_count`::
|
||||||
|
(integer) The number of write operations queued on the follower.
|
||||||
|
|
||||||
|
write_buffer_size_in_bytes`::
|
||||||
|
(long) The total number of bytes of operations currently queued for writing.
|
||||||
|
=====
|
||||||
|
//End shards
|
||||||
|
====
|
||||||
|
//End indices
|
||||||
|
|
||||||
[[ccr-get-follow-stats-examples]]
|
[[ccr-get-follow-stats-examples]]
|
||||||
==== {api-examples-title}
|
==== {api-examples-title}
|
||||||
|
|
|
||||||
|
|
@ -51,39 +51,41 @@ This API gets {ccr} stats. This API will return all stats related to {ccr}. In
|
||||||
particular, this API returns stats about auto-following, and returns the same
|
particular, this API returns stats about auto-following, and returns the same
|
||||||
shard-level stats as in the <<ccr-get-follow-stats,get follower stats API>>.
|
shard-level stats as in the <<ccr-get-follow-stats,get follower stats API>>.
|
||||||
|
|
||||||
|
[role="child_attributes"]
|
||||||
[[ccr-get-stats-response-body]]
|
[[ccr-get-stats-response-body]]
|
||||||
==== {api-response-body-title}
|
==== {api-response-body-title}
|
||||||
|
|
||||||
This API returns the following information:
|
//Begin auto_follow_stats
|
||||||
|
|
||||||
`auto_follow_stats`::
|
`auto_follow_stats`::
|
||||||
(object) An object representing stats for the auto-follow coordinator.
|
(object) An object representing stats for the auto-follow coordinator.
|
||||||
|
+
|
||||||
|
.Properties of `auto_follow_stats`
|
||||||
|
[%collapsible%open]
|
||||||
|
====
|
||||||
|
`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.
|
||||||
|
|
||||||
This object consists of the following fields:
|
`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_failed_follow_indices`::
|
`number_of_successful_follow_indices`::
|
||||||
(long) The number of indices that the auto-follow coordinator failed to
|
(long) The number of indices that the auto-follow coordinator successfully
|
||||||
automatically follow. The causes of recent failures are captured in the logs
|
followed.
|
||||||
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`::
|
`recent_auto_follow_errors`::
|
||||||
(long) The number of times that the auto-follow coordinator failed to retrieve
|
(array) An array of objects representing failures by the auto-follow coordinator.
|
||||||
the cluster state from a remote cluster registered in a collection of
|
====
|
||||||
auto-follow patterns.
|
//End auto_follow_stats
|
||||||
|
|
||||||
`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`::
|
`follow_stats`::
|
||||||
(object) An object representing shard-level stats for follower indices; refer
|
(object) An object representing shard-level stats for follower indices; refer to
|
||||||
to the details of the response in the
|
the details of the response in the
|
||||||
<<ccr-get-follow-stats,get follower stats API>>.
|
<<ccr-get-follow-stats,get follower stats API>>.
|
||||||
|
|
||||||
[[ccr-get-stats-examples]]
|
[[ccr-get-stats-examples]]
|
||||||
==== {api-examples-title}
|
==== {api-examples-title}
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue