Skip to content

Commit 2409984

Browse files
Add CPU usage metrics (#2043)
The corresponding PRs are neo-technology/neo4j#28128 and https://github.com/neo-technology/neo4j/pull/28439/files --------- Co-authored-by: Fábio Botelho <[email protected]>
1 parent d9529e7 commit 2409984

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

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

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -500,15 +500,29 @@ label:deprecated[Deprecated in 5.15]
500500
[[jvm-metrics]]
501501
== Java Virtual Machine Metrics
502502

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.
504504
They are environment dependent and therefore, may vary on different hardware and with different JVM configurations.
505+
505506
The metrics about the JVM's memory usage expose values that are provided by the MemoryPoolMXBeans and BufferPoolMXBeans.
506507
The memory pools are memory managed by the JVM, for example, `neo4j.dbms.vm.memory.pool.g1_survivor_space`.
507508
Therefore, if necessary, you can tune them using the JVM settings.
509+
508510
The buffer pools are space outside of the memory managed by the garbage collector.
509511
Neo4j allocates buffers in those pools as it needs them.
510512
You can limit this memory using JVM settings, but there is never any good reason for you to set them.
511513

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)
524+
|===
525+
512526
[[jvm-file-descriptor-metrics]]
513527
=== JVM file descriptor metrics
514528

0 commit comments

Comments
 (0)