Skip to content

Commit

Permalink
[8.13] describe the values in the CCR metrics table (#184545) (#184661)
Browse files Browse the repository at this point in the history
# Backport

This will backport the following commits from `main` to `8.13`:
- [describe the values in the CCR metrics table
(#184545)](#184545)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT
[{"author":{"name":"shainaraskas","email":"58563081+shainaraskas@users.noreply.github.com"},"sourceCommit":{"committedDate":"2024-06-03T14:46:40Z","message":"describe
the values in the CCR metrics table
(#184545)","sha":"5a3251af2fb1cafc36c002009d0296f8b58f057a","branchLabelMapping":{"^v8.15.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Docs","Feature:CCR
and Remote
Clusters","release_note:skip","docs","v8.13.0","v8.14.0","v8.15.0"],"title":"describe
the values in the CCR metrics
table","number":184545,"url":"https://github.com/elastic/kibana/pull/184545","mergeCommit":{"message":"describe
the values in the CCR metrics table
(#184545)","sha":"5a3251af2fb1cafc36c002009d0296f8b58f057a"}},"sourceBranch":"main","suggestedTargetBranches":["8.13","8.14"],"targetPullRequestStates":[{"branch":"8.13","label":"v8.13.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.14","label":"v8.14.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.15.0","branchLabelMappingKey":"^v8.15.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/184545","number":184545,"mergeCommit":{"message":"describe
the values in the CCR metrics table
(#184545)","sha":"5a3251af2fb1cafc36c002009d0296f8b58f057a"}}]}]
BACKPORT-->

Co-authored-by: shainaraskas <58563081+shainaraskas@users.noreply.github.com>
  • Loading branch information
kibanamachine and shainaraskas authored Jun 3, 2024
1 parent 2465d50 commit 4b896a8
Showing 1 changed file with 29 additions and 6 deletions.
35 changes: 29 additions & 6 deletions docs/user/monitoring/elasticsearch-details.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -108,16 +108,39 @@ 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:

- **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 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 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
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.

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 shard, you can see graphs for the fetch and operation delays.
You can also see advanced information, which contains the results from the
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]]
Expand Down

0 comments on commit 4b896a8

Please sign in to comment.