Skip to content

Commit ea5fd70

Browse files
Remove deprecated and removed Cluster metrics (#2036)
The Raft core metrics and Read replica metrics were old names from 4.x, supported during 5.x. They have been removed in 2025.01
1 parent 14d889e commit ea5fd70

File tree

1 file changed

+0
-120
lines changed

1 file changed

+0
-120
lines changed

modules/ROOT/pages/monitoring/metrics/reference.adoc

Lines changed: 0 additions & 120 deletions
Original file line numberDiff line numberDiff line change
@@ -452,99 +452,6 @@ label:deprecated[Deprecated in 5.15]
452452
|<prefix>.cluster.discovery.memberset.unreachable|Number of unreachable cluster members. (gauge)
453453
|===
454454

455-
[[raft-core-metrics]]
456-
=== Raft core metrics
457-
458-
label:deprecated[Deprecated in 5.0]
459-
460-
.Raft core metrics
461-
[options="header",cols="<3m,<4"]
462-
|===
463-
|Name
464-
|Description
465-
466-
|<prefix>.causal_clustering.core.append_index
467-
|The append index of the Raft log. Each index represents a write transaction (possibly internal) proposed for commitment. The values mostly increase, but sometimes they can decrease as a consequence of leader changes. The append index should always be bigger than or equal to the commit index. (gauge)
468-
469-
|<prefix>.causal_clustering.core.commit_index
470-
|The commit index of the Raft log. Represents the commitment of previously appended entries. Its value increases monotonically if you do not unbind the cluster state. The commit index should always be less than or equal to the append index and bigger than or equal to the applied index. (gauge)
471-
472-
|<prefix>.causal_clustering.core.applied_index
473-
|The applied index of the Raft log. Represents the application of the committed Raft log entries to the database and internal state. The applied index should always be less than or equal to the commit index. The difference between this and the commit index can be used to monitor how up-to-date the follower database is. (gauge)
474-
475-
|<prefix>.causal_clustering.core.term
476-
|The Raft Term of this server. It increases monotonically if you do not unbind the cluster state. (gauge)
477-
478-
|<prefix>.causal_clustering.core.tx_retries
479-
|Transaction retries. (counter)
480-
481-
|<prefix>.causal_clustering.core.is_leader
482-
|Is this server the leader? Track this for each Core cluster member. It will report 0 if it is not the leader and 1 if it is the leader. The sum of all of these should always be 1. However, there will be transient periods in which the sum can be more than 1 because more than one member thinks it is the leader. Action may be needed if the metric shows 0 for more than 30 seconds. (gauge)
483-
484-
|<prefix>.causal_clustering.core.in_flight_cache.total_bytes
485-
|In-flight cache total bytes. (gauge)
486-
487-
|<prefix>.causal_clustering.core.in_flight_cache.max_bytes
488-
|In-flight cache max bytes. (gauge)
489-
490-
|<prefix>.causal_clustering.core.in_flight_cache.element_count
491-
|In-flight cache element count. (gauge)
492-
493-
|<prefix>.causal_clustering.core.in_flight_cache.max_elements
494-
|In-flight cache maximum elements. (gauge)
495-
496-
|<prefix>.causal_clustering.core.in_flight_cache.hits
497-
|In-flight cache hits. (counter)
498-
499-
|<prefix>.causal_clustering.core.in_flight_cache.misses
500-
|In-flight cache misses. (counter)
501-
502-
|<prefix>.causal_clustering.core.raft_log_entry_prefetch_buffer.lag
503-
|Raft Log Entry Prefetch Lag. (gauge)
504-
505-
|<prefix>.causal_clustering.core.raft_log_entry_prefetch_buffer.bytes
506-
|Raft Log Entry Prefetch total bytes. (gauge)
507-
508-
|<prefix>.causal_clustering.core.raft_log_entry_prefetch_buffer.size
509-
|Raft Log Entry Prefetch buffer size. (gauge)
510-
511-
|<prefix>.causal_clustering.core.raft_log_entry_prefetch_buffer.async_put
512-
|Raft Log Entry Prefetch buffer async puts. (gauge)
513-
514-
|<prefix>.causal_clustering.core.raft_log_entry_prefetch_buffer.sync_put
515-
|Raft Log Entry Prefetch buffer sync puts. (gauge)
516-
517-
|<prefix>.causal_clustering.core.message_processing_delay
518-
|Delay between Raft message receive and process. (gauge)
519-
520-
|<prefix>.causal_clustering.core.message_processing_timer
521-
|Timer for Raft message processing. (counter, histogram)
522-
523-
|<prefix>.causal_clustering.core.replication_new
524-
|The total number of Raft replication requests. It increases with write transactions (possibly internal) activity. (counter)
525-
526-
|<prefix>.causal_clustering.core.replication_attempt
527-
|The total number of Raft replication requests attempts. It is bigger or equal than the replication requests. (counter)
528-
529-
|<prefix>.causal_clustering.core.replication_fail
530-
|The total number of Raft replication attempts that have failed. (counter)
531-
532-
|<prefix>.causal_clustering.core.replication_maybe
533-
|Raft Replication maybe count. (counter)
534-
535-
|<prefix>.causal_clustering.core.replication_success
536-
|The total number of Raft replication requests that have succeeded. (counter)
537-
538-
|<prefix>.causal_clustering.core.last_leader_message
539-
|The time elapsed since the last message from a leader in milliseconds. Should reset periodically. (gauge)
540-
|===
541-
542-
[IMPORTANT]
543-
====
544-
Metrics specific to _Causal Clustering_ are deprecated, as the previous table shows.
545-
The deprecated Raft core metrics are replaced accordingly by the Raft metrics in the following table.
546-
====
547-
548455
[[raft-metrics]]
549456
=== Raft metrics
550457

@@ -585,33 +492,6 @@ The deprecated Raft core metrics are replaced accordingly by the Raft metrics in
585492
|===
586493

587494

588-
[[read-replica-metrics]]
589-
=== Read Replica metrics
590-
591-
label:deprecated[Deprecated in 5.0]
592-
593-
.Read Replica metrics
594-
[options="header",cols="<3m,<4"]
595-
|===
596-
|Name
597-
|Description
598-
599-
|<prefix>.causal_clustering.read_replica.pull_updates
600-
|The total number of pull requests made by this instance. (counter)
601-
602-
|<prefix>.causal_clustering.read_replica.pull_update_highest_tx_id_requested
603-
|The highest transaction id requested in a pull update by this instance. (counter)
604-
605-
|<prefix>.causal_clustering.read_replica.pull_update_highest_tx_id_received
606-
|The highest transaction id that has been pulled in the last pull updates by this instance. (counter)
607-
|===
608-
609-
[IMPORTANT]
610-
====
611-
Metrics specific to _Causal Clustering_ are deprecated, as the previous table shows.
612-
The deprecated Read Replica metrics are replaced accordingly by the Story copy metrics in the following table.
613-
====
614-
615495
[[store-copy-metrics]]
616496
=== Store copy metrics
617497

0 commit comments

Comments
 (0)