From c048ac98ce065fa5dcb9e28fd37fbbb35d88cd3f Mon Sep 17 00:00:00 2001 From: Natalia Ivakina Date: Thu, 9 Jan 2025 17:01:01 +0100 Subject: [PATCH 1/2] Add CPU usage metrics --- .../ROOT/pages/monitoring/metrics/reference.adoc | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/modules/ROOT/pages/monitoring/metrics/reference.adoc b/modules/ROOT/pages/monitoring/metrics/reference.adoc index 30f289f58..27f302bc6 100644 --- a/modules/ROOT/pages/monitoring/metrics/reference.adoc +++ b/modules/ROOT/pages/monitoring/metrics/reference.adoc @@ -500,15 +500,29 @@ label:deprecated[Deprecated in 5.15] [[jvm-metrics]] == Java Virtual Machine Metrics -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. +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. They are environment dependent and therefore, may vary on different hardware and with different JVM configurations. + The metrics about the JVM's memory usage expose values that are provided by the MemoryPoolMXBeans and BufferPoolMXBeans. The memory pools are memory managed by the JVM, for example, `neo4j.dbms.vm.memory.pool.g1_survivor_space`. Therefore, if necessary, you can tune them using the JVM settings. + The buffer pools are space outside of the memory managed by the garbage collector. 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. +[role=label--new-2025.01] +[[cpu-usage-metrics]] +=== CPU usage metrics + +.CPU usage metrics +[options="header",cols="<3m,<4"] +|=== +|Name |Description +|.vm.cpu_load.system|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) +|.vm.cpu_load.process|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) +|=== + [[jvm-file-descriptor-metrics]] === JVM file descriptor metrics From 017f06edf708cf29201e5456c54ea0eb4a0b47af Mon Sep 17 00:00:00 2001 From: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com> Date: Fri, 10 Jan 2025 10:38:53 +0100 Subject: [PATCH 2/2] Update modules/ROOT/pages/monitoring/metrics/reference.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Fábio Botelho --- modules/ROOT/pages/monitoring/metrics/reference.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/modules/ROOT/pages/monitoring/metrics/reference.adoc b/modules/ROOT/pages/monitoring/metrics/reference.adoc index 27f302bc6..f3872f416 100644 --- a/modules/ROOT/pages/monitoring/metrics/reference.adoc +++ b/modules/ROOT/pages/monitoring/metrics/reference.adoc @@ -519,8 +519,8 @@ You can limit this memory using JVM settings, but there is never any good reason [options="header",cols="<3m,<4"] |=== |Name |Description -|.vm.cpu_load.system|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) -|.vm.cpu_load.process|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) +|.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) +|.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) |=== [[jvm-file-descriptor-metrics]]