You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: modules/ROOT/pages/monitoring/metrics/reference.adoc
+15-1Lines changed: 15 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -500,15 +500,29 @@ label:deprecated[Deprecated in 5.15]
500
500
[[jvm-metrics]]
501
501
== Java Virtual Machine Metrics
502
502
503
-
The JVM metrics show information about garbage collections (for example, the number of events and time spent collecting), memory pools and buffers, and the number of active threads running.
503
+
The JVM metrics show information about garbage collections (for example, the number of events and time spent collecting), memory pools and buffers, the number of active threads running, and the usage of central processing unit (CPU) for the Neo4j process and operating system.
504
504
They are environment dependent and therefore, may vary on different hardware and with different JVM configurations.
505
+
505
506
The metrics about the JVM's memory usage expose values that are provided by the MemoryPoolMXBeans and BufferPoolMXBeans.
506
507
The memory pools are memory managed by the JVM, for example, `neo4j.dbms.vm.memory.pool.g1_survivor_space`.
507
508
Therefore, if necessary, you can tune them using the JVM settings.
509
+
508
510
The buffer pools are space outside of the memory managed by the garbage collector.
509
511
Neo4j allocates buffers in those pools as it needs them.
510
512
You can limit this memory using JVM settings, but there is never any good reason for you to set them.
511
513
514
+
[role=label--new-2025.01]
515
+
[[cpu-usage-metrics]]
516
+
=== CPU usage metrics
517
+
518
+
.CPU usage metrics
519
+
[options="header",cols="<3m,<4"]
520
+
|===
521
+
|Name |Description
522
+
|<prefix>.vm.cpu_load.system|The recent CPU usage for the operating system. This value is a double in the [0.0, 1.0] interval. Depending on the Java distribution you use, the metric may be unavailable. (gauge)
523
+
|<prefix>.vm.cpu_load.process|The recent CPU usage for the Neo4j process. This value is a double in the [0.0, 1.0] interval. Depending on the Java distribution you use, the metric may be unavailable. (gauge)
0 commit comments