From ff082a187d6836ed6baf635d544bc0f34719b891 Mon Sep 17 00:00:00 2001 From: shainaraskas Date: Thu, 30 May 2024 16:47:45 -0400 Subject: [PATCH 1/5] describe the values in the CCR metrics table --- .../monitoring/elasticsearch-details.asciidoc | 27 ++++++++++++++----- 1 file changed, 21 insertions(+), 6 deletions(-) diff --git a/docs/user/monitoring/elasticsearch-details.asciidoc b/docs/user/monitoring/elasticsearch-details.asciidoc index 74c8122d4cad1..f0dea3a0c5120 100644 --- a/docs/user/monitoring/elasticsearch-details.asciidoc +++ b/docs/user/monitoring/elasticsearch-details.asciidoc @@ -108,13 +108,28 @@ model, the number of forecasts, and the node that runs the job. == CCR To view {ccr} metrics, click **CCR**. For each follower index on the cluster, it -shows information such as the leader index, an indication of how much the -follower index is lagging behind the leader index, the last fetch time, the -number of operations synced, and error messages. If you select a follower index, -you can view the same information for each shard. +shows the following information: -If you select a shard, you can see graphs for the fetch and operation delays. -You can also see advanced information, which contains the results from the +- **Index**: The name of the follower index. +- **Follows**: The name of the leader index. +- **Alerts**: Any read exceptions that have been triggered for the index or its shards. +- **Sync Lag (ops)**: How many operations the follower index is lagging behind the leader index. +This is calculated by subtracting the delta of `follower_global_checkpoint` from the delta of +`leader_max_seq_no` for each shard, and displaying the maximum value. +- **Last fetch time**: The time elapsed since the last successful fetch from the leader index. +Represents the longest time elapsed across all of the shards in the follower index. +- **Ops synced**: The number of operations indexed into the follower index from the leader index +in the selected time period. This is the sum of the delta between the maximum and minimum number of +operations indexed across all of the shards in the follower index during the time period. +- **Error**: Any exceptions returned for the most recent document in the time period. + +For more information on the properties used to calculate these metrics, refer to the {ref}/ccr-get-follow-stats.html[get follower stats API] documentation. + +If you select a follower index, you can view the same information for each shard. + +If you select a shard, you can see graphs for the fetch and operation delays. + +You can also see advanced information, which contains additional stats from the {ref}/ccr-get-follow-stats.html[get follower stats API]. For more information, refer to {ref}/xpack-ccr.html[{ccr-cap}]. From 446fe52d9d855996d4302e994c30abc3d2ee12a9 Mon Sep 17 00:00:00 2001 From: shainaraskas Date: Fri, 31 May 2024 12:05:50 -0400 Subject: [PATCH 2/5] better? --- .../monitoring/elasticsearch-details.asciidoc | 22 ++++++++++++------- 1 file changed, 14 insertions(+), 8 deletions(-) diff --git a/docs/user/monitoring/elasticsearch-details.asciidoc b/docs/user/monitoring/elasticsearch-details.asciidoc index f0dea3a0c5120..6a5d6d80bace7 100644 --- a/docs/user/monitoring/elasticsearch-details.asciidoc +++ b/docs/user/monitoring/elasticsearch-details.asciidoc @@ -114,16 +114,22 @@ shows the following information: - **Follows**: The name of the leader index. - **Alerts**: Any read exceptions that have been triggered for the index or its shards. - **Sync Lag (ops)**: How many operations the follower index is lagging behind the leader index. -This is calculated by subtracting the delta of `follower_global_checkpoint` from the delta of -`leader_max_seq_no` for each shard, and displaying the maximum value. ++ +This is calculated by finding the difference between the minimum and maximum operation sequence number +on the leader (`leader_max_seq_no`) and the difference between the minimum and maximum global checkpoint +on the follower (`follower_global_checkpoint`) for each shard over the selected time period. The difference +in `follower_global_checkpoint` is subtracted from the difference in `leader_max_seq_no` for each shard, +and the highest result across all shards is displayed. - **Last fetch time**: The time elapsed since the last successful fetch from the leader index. Represents the longest time elapsed across all of the shards in the follower index. -- **Ops synced**: The number of operations indexed into the follower index from the leader index -in the selected time period. This is the sum of the delta between the maximum and minimum number of -operations indexed across all of the shards in the follower index during the time period. -- **Error**: Any exceptions returned for the most recent document in the time period. - -For more information on the properties used to calculate these metrics, refer to the {ref}/ccr-get-follow-stats.html[get follower stats API] documentation. +- **Ops synced**: The number of operations indexed (replicated) into the follower index from the leader +index in the selected time period. ++ +This metric is a sum of the number of operations indexed across all shards over the selected time period. +- **Error**: Any exceptions returned for the most recent document in the selected time period. + +For more information on the properties used to calculate these metrics, refer to the +{ref}/ccr-get-follow-stats.html[get follower stats API] documentation. If you select a follower index, you can view the same information for each shard. From 77c2d851cab3f343ce034ddf7dd373750497dbd0 Mon Sep 17 00:00:00 2001 From: shainaraskas Date: Fri, 31 May 2024 12:14:50 -0400 Subject: [PATCH 3/5] wrap --- .../monitoring/elasticsearch-details.asciidoc | 24 +++++++++++-------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/docs/user/monitoring/elasticsearch-details.asciidoc b/docs/user/monitoring/elasticsearch-details.asciidoc index 6a5d6d80bace7..256eb0400c5f6 100644 --- a/docs/user/monitoring/elasticsearch-details.asciidoc +++ b/docs/user/monitoring/elasticsearch-details.asciidoc @@ -112,20 +112,24 @@ shows the following information: - **Index**: The name of the follower index. - **Follows**: The name of the leader index. -- **Alerts**: Any read exceptions that have been triggered for the index or its shards. -- **Sync Lag (ops)**: How many operations the follower index is lagging behind the leader index. +- **Alerts**: Any read exceptions that have been triggered for the index or its +shards. +- **Sync Lag (ops)**: How many operations the follower index is lagging behind the +leader index. + -This is calculated by finding the difference between the minimum and maximum operation sequence number -on the leader (`leader_max_seq_no`) and the difference between the minimum and maximum global checkpoint -on the follower (`follower_global_checkpoint`) for each shard over the selected time period. The difference -in `follower_global_checkpoint` is subtracted from the difference in `leader_max_seq_no` for each shard, -and the highest result across all shards is displayed. +This is calculated by finding the difference between the minimum and maximum operation +sequence number on the leader (`leader_max_seq_no`) and the difference between the minimum +and maximum global checkpoint on the follower (`follower_global_checkpoint`) for each shard +over the selected time period. The difference in `follower_global_checkpoint` is subtracted +from the difference in `leader_max_seq_no` for each shard, and the highest result across all +shards is displayed. - **Last fetch time**: The time elapsed since the last successful fetch from the leader index. Represents the longest time elapsed across all of the shards in the follower index. -- **Ops synced**: The number of operations indexed (replicated) into the follower index from the leader -index in the selected time period. +- **Ops synced**: The number of operations indexed (replicated) into the follower index from +the leader index in the selected time period. + -This metric is a sum of the number of operations indexed across all shards over the selected time period. +This metric is a sum of the number of operations indexed across all shards over the selected +time period. - **Error**: Any exceptions returned for the most recent document in the selected time period. For more information on the properties used to calculate these metrics, refer to the From 2014e58ca86c809513e3ec262895e9bc80cef16e Mon Sep 17 00:00:00 2001 From: shainaraskas Date: Fri, 31 May 2024 13:06:23 -0400 Subject: [PATCH 4/5] clarify --- docs/user/monitoring/elasticsearch-details.asciidoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/user/monitoring/elasticsearch-details.asciidoc b/docs/user/monitoring/elasticsearch-details.asciidoc index 256eb0400c5f6..d399dfd16c3c0 100644 --- a/docs/user/monitoring/elasticsearch-details.asciidoc +++ b/docs/user/monitoring/elasticsearch-details.asciidoc @@ -119,10 +119,10 @@ leader index. + This is calculated by finding the difference between the minimum and maximum operation sequence number on the leader (`leader_max_seq_no`) and the difference between the minimum -and maximum global checkpoint on the follower (`follower_global_checkpoint`) for each shard -over the selected time period. The difference in `follower_global_checkpoint` is subtracted -from the difference in `leader_max_seq_no` for each shard, and the highest result across all -shards is displayed. +and maximum global sequence number checkpoint on the follower (`follower_global_checkpoint`) +for each shard over the selected time period. The difference in `follower_global_checkpoint` +is subtracted from the difference in `leader_max_seq_no` for each shard, and the highest result +across all shards is displayed. - **Last fetch time**: The time elapsed since the last successful fetch from the leader index. Represents the longest time elapsed across all of the shards in the follower index. - **Ops synced**: The number of operations indexed (replicated) into the follower index from From fb8acc085f0debd0739a46a677bb742e32b654f6 Mon Sep 17 00:00:00 2001 From: shainaraskas Date: Fri, 31 May 2024 13:40:09 -0400 Subject: [PATCH 5/5] fewer one-line paras --- docs/user/monitoring/elasticsearch-details.asciidoc | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/docs/user/monitoring/elasticsearch-details.asciidoc b/docs/user/monitoring/elasticsearch-details.asciidoc index d399dfd16c3c0..f8a8894c29207 100644 --- a/docs/user/monitoring/elasticsearch-details.asciidoc +++ b/docs/user/monitoring/elasticsearch-details.asciidoc @@ -132,17 +132,15 @@ This metric is a sum of the number of operations indexed across all shards over time period. - **Error**: Any exceptions returned for the most recent document in the selected time period. +If you select a follower index, you can view the same information for each shard. For more information on the properties used to calculate these metrics, refer to the {ref}/ccr-get-follow-stats.html[get follower stats API] documentation. -If you select a follower index, you can view the same information for each shard. - -If you select a shard, you can see graphs for the fetch and operation delays. - +If you select a shard, you can see graphs for the fetch and operation delays. You can also see advanced information, which contains additional stats from the {ref}/ccr-get-follow-stats.html[get follower stats API]. -For more information, refer to {ref}/xpack-ccr.html[{ccr-cap}]. +Learn more about {ref}/xpack-ccr.html[{ccr-cap}]. [float] [[logs-monitor-page]]