Skip to content

Commit

Permalink
Add third-level titles to the Metrics ref page (neo4j#1435)
Browse files Browse the repository at this point in the history
Make metric classes more visible.
  • Loading branch information
NataliaIvakina authored Feb 23, 2024
1 parent 7e75e71 commit 5b7dad5
Showing 1 changed file with 78 additions and 34 deletions.
112 changes: 78 additions & 34 deletions modules/ROOT/pages/monitoring/metrics/reference.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
:description: This section includes metrics that are primarily to allow Neo4j experts to fine-tune specific issues.
:page-styles: hide-table-captions

[role=enterprise-edition]
[[metrics-reference]]
= Metrics reference
Expand Down Expand Up @@ -74,8 +76,9 @@ By default, database metrics include:
== General-purpose metrics

[[bolt-metrics]]
.Bolt metrics
=== Bolt metrics

.Bolt metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -95,8 +98,11 @@ By default, database metrics include:
|===

[[bolt-driver-metrics]]
.Bolt Driver metrics label:new[Introduced in 5.13]
=== Bolt Driver metrics

label:new[Introduced in 5.13]

.Bolt Driver metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -107,8 +113,9 @@ By default, database metrics include:
|===

[[checkpointing-metrics]]
.Database checkpointing metrics
=== Database checkpointing metrics

.Database checkpointing metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -124,8 +131,9 @@ By default, database metrics include:
|===

[[cypher-metrics]]
.Cypher metrics
=== Cypher metrics

.Cypher metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -134,8 +142,9 @@ By default, database metrics include:
|===

[[db-data-count-metrics]]
.Database data count metrics
=== Database data count metrics

.Database data count metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -145,8 +154,9 @@ By default, database metrics include:
|===

[[db-neo4j-pool-metrics]]
.Database neo4j pools metrics
=== Database neo4j pools metrics

.Database neo4j pools metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -159,8 +169,9 @@ By default, database metrics include:


[[db-operation-count-metrics]]
.Database operation count metrics
=== Database operation count metrics

.Database operation count metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -173,8 +184,11 @@ By default, database metrics include:
|===

[[db-state-count-metrics]]
.Database state count metrics label:new[Introduced in 5.7]
=== Database state count metrics

label:new[Introduced in 5.7]

.Database state count metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -184,8 +198,11 @@ By default, database metrics include:
|===

[[db-data-metrics]]
.Database data metrics label:deprecated[Deprecated in 5.15]
=== Database data metrics

label:deprecated[Deprecated in 5.15]

.Database data metrics
[options="header",cols="<3m,<4"]
|===
|Name
Expand All @@ -205,8 +222,9 @@ By default, database metrics include:
|===

[[global-neo4j-pools-metrics]]
.Global neo4j pools metrics
=== Global neo4j pools metrics

.Global neo4j pools metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -218,8 +236,9 @@ By default, database metrics include:
|===

[[db-page-cache-metrics]]
.Database page cache metrics
=== Database page cache metrics

.Database page cache metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand Down Expand Up @@ -250,8 +269,9 @@ By default, database metrics include:
|===

[[query-execution-metrics]]
.Query execution metrics
=== Query execution metrics

.Query execution metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -270,8 +290,11 @@ By default, database metrics include:
|===

[[query-routing-metrics]]
.Query routing metrics label:new[Introduced in 5.10]
=== Query routing metrics

label:new[Introduced in 5.10]

.Query routing metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -284,8 +307,9 @@ By default, database metrics include:
|===

[[db-store-size-metrics]]
.Database store size metrics
=== Database store size metrics

.Database store size metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -294,8 +318,9 @@ By default, database metrics include:
|===

[[db-tx-log-metrics]]
.Database transaction log metrics
=== Database transaction log metrics

.Database transaction log metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -308,8 +333,9 @@ By default, database metrics include:
|===

[[db-tx-metrics]]
.Database transaction metrics
=== Database transaction metrics

.Database transaction metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -334,8 +360,9 @@ By default, database metrics include:
|===

[[db-index-metrics]]
.Database index metrics
=== Database index metrics

.Database index metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -359,8 +386,9 @@ By default, database metrics include:
|===

[[server-metrics]]
.Server metrics
=== Server metrics

.Server metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -373,17 +401,19 @@ By default, database metrics include:
== Metrics specific to clustering

[[catchup-metrics]]
.CatchUp metrics
=== CatchUp metrics

.CatchUp metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
|<prefix>.cluster.catchup.tx_pull_requests_received|TX pull requests received from other cluster members. (counter)
|===

[[discovery-metrics]]
.Discovery metrics
=== Discovery metrics

.Discovery metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -396,7 +426,11 @@ By default, database metrics include:
|===

[[raft-core-metrics]]
.Raft core metrics label:deprecated[Deprecated in 5.0]
=== Raft core metrics

label:deprecated[Deprecated in 5.0]

.Raft core metrics
[options="header",cols="<3m,<4"]
|===
|Name
Expand Down Expand Up @@ -485,8 +519,9 @@ The deprecated Raft core metrics are replaced accordingly by the Raft metrics in
====

[[raft-metrics]]
.Raft metrics
=== Raft metrics

.Raft metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand Down Expand Up @@ -520,7 +555,11 @@ The deprecated Raft core metrics are replaced accordingly by the Raft metrics in


[[read-replica-metrics]]
.Read Replica metrics label:deprecated[Deprecated in 5.0]
=== Read Replica metrics

label:deprecated[Deprecated in 5.0]

.Read Replica metrics
[options="header",cols="<3m,<4"]
|===
|Name
Expand All @@ -543,8 +582,9 @@ The deprecated Read Replica metrics are replaced accordingly by the Story copy m
====

[[store-copy-metrics]]
.Store copy metrics
=== Store copy metrics

.Store copy metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -554,8 +594,6 @@ The deprecated Read Replica metrics are replaced accordingly by the Story copy m
|===




[[jvm-metrics]]
== Java Virtual Machine Metrics

Expand All @@ -569,8 +607,9 @@ Neo4j allocates buffers in those pools as it needs them.
You can limit this memory using JVM settings, but there is never any good reason for you to set them.

[[jvm-file-descriptor-metrics]]
.JVM file descriptor metrics
=== JVM file descriptor metrics

.JVM file descriptor metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -579,8 +618,9 @@ You can limit this memory using JVM settings, but there is never any good reason
|===

[[gc-metrics]]
.GC metrics
=== GC metrics

.GC metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -589,8 +629,9 @@ You can limit this memory using JVM settings, but there is never any good reason
|===

[[jvm-heap-metrics]]
.JVM Heap metrics
=== JVM Heap metrics

.JVM Heap metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -600,8 +641,9 @@ You can limit this memory using JVM settings, but there is never any good reason
|===

[[jvm-memory-buffers-metrics]]
.JVM memory buffers metrics
=== JVM memory buffers metrics

.JVM memory buffers metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
Expand All @@ -611,30 +653,32 @@ You can limit this memory using JVM settings, but there is never any good reason
|===

[[jvm-memory-pools-metrics]]
.JVM memory pools metrics
=== JVM memory pools metrics

.JVM memory pools metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
|<prefix>.vm.memory.pool.<pool>|Estimated amount of memory in bytes used by the pool. (gauge)
|===

[[jvm-pause-time-metrics]]
.JVM pause time metrics
=== JVM pause time metrics

.JVM pause time metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
|<prefix>.vm.pause_time|Accumulated detected VM pause time. (counter)
|===

[[jvm-threads-metrics]]
.JVM threads metrics
=== JVM threads metrics

.JVM threads metrics
[options="header",cols="<3m,<4"]
|===
|Name |Description
|<prefix>.vm.threads|The total number of live threads including daemon and non-daemon threads. (gauge)
|===


0 comments on commit 5b7dad5

Please sign in to comment.