add deprecated causal clustering metrics (#1423) (#1425)

Author: AlexicaWright

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

@@ -184,15 +184,24 @@ By default, database metrics include:
 |===
 
 [[db-data-metrics]]
-.Database data metrics
+.Database data metrics label:deprecated[Deprecated in 5.15]
 
 [options="header",cols="<3m,<4"]
 |===
-|Name |Description
-|<prefix>.ids_in_use.relationship_type|label:deprecated[Deprecated in 5.15]The total number of internally generated IDs for the different relationship types stored in the database. These IDs do not reflect changes in the actual data. Informational, not an indication of any issue. (gauge)
-|<prefix>.ids_in_use.property|label:deprecated[Deprecated in 5.15]The total number of internally generated IDs for the different property names stored in the database. These IDs do not reflect changes in the actual data. Informational, not an indication of any issue. (gauge)
-|<prefix>.ids_in_use.relationship|label:deprecated[Deprecated in 5.15]The total number of internally generated reusable IDs for the relationships stored in the database. These IDs do not reflect changes in the actual data. If you want to have a rough metric of how big your graph is, use `<prefix>.neo4j.count.relationship` instead. (gauge)
-|<prefix>.ids_in_use.node|label:deprecated[Deprecated in 5.15]The total number of internally generated reusable IDs for the nodes stored in the database. These IDs do not reflect changes in the actual data. If you want to have a rough metric of how big your graph is, use `<prefix>.neo4j.count.node` instead. (gauge)
+|Name
+|Description
+
+|<prefix>.ids_in_use.relationship_type
+|The total number of internally generated IDs for the different relationship types stored in the database. These IDs do not reflect changes in the actual data. Informational, not an indication of any issue. (gauge)
+
+|<prefix>.ids_in_use.property
+|The total number of internally generated IDs for the different property names stored in the database. These IDs do not reflect changes in the actual data. Informational, not an indication of any issue. (gauge)
+
+|<prefix>.ids_in_use.relationship
+|The total number of internally generated reusable IDs for the relationships stored in the database. These IDs do not reflect changes in the actual data. If you want to have a rough metric of how big your graph is, use `<prefix>.neo4j.count.relationship` instead. (gauge)
+
+|<prefix>.ids_in_use.node
+|The total number of internally generated reusable IDs for the nodes stored in the database. These IDs do not reflect changes in the actual data. If you want to have a rough metric of how big your graph is, use `<prefix>.neo4j.count.node` instead. (gauge)
 |===
 
 [[global-neo4j-pools-metrics]]
@@ -259,17 +268,21 @@ By default, database metrics include:
 |===
 
 [[query-routing-metrics]]
-.Query routing metrics
+.Query routing metrics label:new[Introduced in 5.10]
 
 [options="header",cols="<3m,<4"]
 |===
-|Name |Description
-|<prefix>.dbms.routing.query.count.local|label:new[Introduced in 5.10]
-The total number of queries executed locally. (counter)
-|<prefix>.dbms.routing.query.count.remote_internal|label:new[Introduced in 5.10]
-The total number of queries executed remotely to a member of the same cluster. (counter)
-|<prefix>.dbms.routing.query.count.remote_external|label:new[Introduced in 5.10]
-The total number of queries executed remotely to a member of a different cluster. (counter)
+|Name
+|Description
+
+|<prefix>.dbms.routing.query.count.local
+|The total number of queries executed locally. (counter)
+
+|<prefix>.dbms.routing.query.count.remote_internal
+|The total number of queries executed remotely to a member of the same cluster. (counter)
+
+|<prefix>.dbms.routing.query.count.remote_external
+|The total number of queries executed remotely to a member of a different cluster. (counter)
 |===
 
 [[db-store-size-metrics]]
@@ -384,6 +397,95 @@ The total number of queries executed remotely to a member of a different cluster
 |<prefix>.cluster.discovery.restart.failed_count|Discovery restart failed count. (gauge)
 |===
 
+[[raft-core-metrics]]
+.Raft core metrics label:deprecated[Deprecated in 5.0]
+[options="header",cols="<3m,<4"]
+|===
+|Name
+|Description
+
+|<prefix>.causal_clustering.core.append_index
+|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)
+
+|<prefix>.causal_clustering.core.commit_index
+|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)
+
+|<prefix>.causal_clustering.core.applied_index
+|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)
+
+|<prefix>.causal_clustering.core.term
+|The Raft Term of this server. It increases monotonically if you do not unbind the cluster state. (gauge)
+
+|<prefix>.causal_clustering.core.tx_retries
+|Transaction retries. (counter)
+
+|<prefix>.causal_clustering.core.is_leader
+|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)
+
+|<prefix>.causal_clustering.core.in_flight_cache.total_bytes
+|In-flight cache total bytes. (gauge)
+
+|<prefix>.causal_clustering.core.in_flight_cache.max_bytes
+|In-flight cache max bytes. (gauge)
+
+|<prefix>.causal_clustering.core.in_flight_cache.element_count
+|In-flight cache element count. (gauge)
+
+|<prefix>.causal_clustering.core.in_flight_cache.max_elements
+|In-flight cache maximum elements. (gauge)
+
+|<prefix>.causal_clustering.core.in_flight_cache.hits
+|In-flight cache hits. (counter)
+
+|<prefix>.causal_clustering.core.in_flight_cache.misses
+|In-flight cache misses. (counter)
+
+|<prefix>.causal_clustering.core.raft_log_entry_prefetch_buffer.lag
+|Raft Log Entry Prefetch Lag. (gauge)
+
+|<prefix>.causal_clustering.core.raft_log_entry_prefetch_buffer.bytes
+|Raft Log Entry Prefetch total bytes. (gauge)
+
+|<prefix>.causal_clustering.core.raft_log_entry_prefetch_buffer.size
+|Raft Log Entry Prefetch buffer size. (gauge)
+
+|<prefix>.causal_clustering.core.raft_log_entry_prefetch_buffer.async_put
+|Raft Log Entry Prefetch buffer async puts. (gauge)
+
+|<prefix>.causal_clustering.core.raft_log_entry_prefetch_buffer.sync_put
+|Raft Log Entry Prefetch buffer sync puts. (gauge)
+
+|<prefix>.causal_clustering.core.message_processing_delay
+|Delay between Raft message receive and process. (gauge)
+
+|<prefix>.causal_clustering.core.message_processing_timer
+|Timer for Raft message processing. (counter, histogram)
+
+|<prefix>.causal_clustering.core.replication_new
+|The total number of Raft replication requests. It increases with write transactions (possibly internal) activity. (counter)
+
+|<prefix>.causal_clustering.core.replication_attempt
+|The total number of Raft replication requests attempts. It is bigger or equal than the replication requests. (counter)
+
+|<prefix>.causal_clustering.core.replication_fail
+|The total number of Raft replication attempts that have failed. (counter)
+
+|<prefix>.causal_clustering.core.replication_maybe
+|Raft Replication maybe count. (counter)
+
+|<prefix>.causal_clustering.core.replication_success
+|The total number of Raft replication requests that have succeeded. (counter)
+
+|<prefix>.causal_clustering.core.last_leader_message
+|The time elapsed since the last message from a leader in milliseconds. Should reset periodically. (gauge)
+|===
+
+[IMPORTANT]
+====
+Metrics specific to _Causal Clustering_ are deprecated, as the previous table shows.
+The deprecated Raft core metrics are replaced accordingly by the Raft metrics in the following table.
+====
+
 [[raft-metrics]]
 .Raft metrics
 
@@ -418,6 +520,30 @@ The total number of queries executed remotely to a member of a different cluster
 |<prefix>.cluster.raft.last_leader_message|The time elapsed since the last message from a leader in milliseconds. Should reset periodically. (gauge)
 |===
 
+
+[[read-replica-metrics]]
+.Read Replica metrics label:deprecated[Deprecated in 5.0]
+[options="header",cols="<3m,<4"]
+|===
+|Name
+|Description
+
+|<prefix>.causal_clustering.read_replica.pull_updates
+|The total number of pull requests made by this instance. (counter)
+
+|<prefix>.causal_clustering.read_replica.pull_update_highest_tx_id_requested
+|The highest transaction id requested in a pull update by this instance. (counter)
+
+|<prefix>.causal_clustering.read_replica.pull_update_highest_tx_id_received
+|The highest transaction id that has been pulled in the last pull updates by this instance. (counter)
+|===
+
+[IMPORTANT]
+====
+Metrics specific to _Causal Clustering_ are deprecated, as the previous table shows.
+The deprecated Read Replica metrics are replaced accordingly by the Story copy metrics in the following table.
+====
+
 [[store-copy-metrics]]
 .Store copy metrics