From 66cd7a92d312886d595e6c653af3478ce57347c4 Mon Sep 17 00:00:00 2001 From: Cyrille Le Clerc Date: Thu, 30 Mar 2023 12:04:37 +0200 Subject: [PATCH] Document new collected runtime metrics --- docs/monitoring-metrics.md | 163 +++++++++++++++++++++++-------------- 1 file changed, 101 insertions(+), 62 deletions(-) diff --git a/docs/monitoring-metrics.md b/docs/monitoring-metrics.md index e83186a24..bf99c32ca 100644 --- a/docs/monitoring-metrics.md +++ b/docs/monitoring-metrics.md @@ -31,8 +31,8 @@ Inventory of health metrics collected by the Jenkins OpenTelemetry integration: Metric Unit - Label / attribute key - Label / attribute value + Attribute Key + Attribute value Description @@ -120,8 +120,8 @@ Inventory of health metrics collected by the Jenkins OpenTelemetry integration: Metric Unit - Label / attribute key - Label / attribute value + Attribute Key + Attribute value Description @@ -174,8 +174,8 @@ Inventory of health metrics collected by the Jenkins OpenTelemetry integration: Metric Unit - Label / attribute key - Label / attribute value + Attribute Key + Attribute value Description @@ -231,100 +231,139 @@ Inventory of health metrics collected by the Jenkins OpenTelemetry integration: - - - - - - - - - - + + + - - - - - + + + + + - - - - - + + + + + - - - - - + + + + + - - + + + - - - + + + - - - - - - + + + + + - - + + + - - - - - - + + + + + - - - - - + + + + + - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + - - - + + + - + + + + + + +
MetricUnitLabel / attribute keyLabel / attribute value Description
runtime.jvm.gc.timemsgc`G1 Young Generation`, `G1 Old Generation...`see GarbageCollectorMXBeanTypeAttribute KeyAttribute value
runtime.jvm.gc.count1gc`G1 Young Generation`, `G1 Old Generation...`see GarbageCollectorMXBeanprocess.runtime.jvm.buffer.countThe number of buffers in the pool gaugepooldirect, mapped, mapped - 'non-volatile memory'
runtime.jvm.memory.areabytestype
area		`used`, `committed`, `max`
`heap`, `non_heap`		see MemoryUsageprocess.runtime.jvm.buffer.limitTotal capacity of the buffers in this pool gaugepooldirect, mapped, mapped - 'non-volatile memory'
runtime.jvm.memory.poolbytestype
pool		`used`, `committed`, `max`. <br/> `PS Eden Space`, `G1 Old Gen...`see MemoryUsageprocess.runtime.jvm.buffer.usageMemory that the Java virtual machine is using for this buffer pool gaugepooldirect, mapped, mapped - 'non-volatile memory'
system.cpu.load1process.runtime.jvm.classes.current.loadedNumber of classes currently loaded gauge System CPU load. See `com.sun.management.OperatingSystemMXBean.getSystemCpuLoad`
system.cpu.load.average.1m1process.runtime.jvm.classes.loadedNumber of classes loaded since JVM start counter System CPU load average 1 minute See `java.lang.management.OperatingSystemMXBean.getSystemLoadAverage`
system.memory.usageBystate`used`, `free`see `com.sun.management.OperatingSystemMXBean.getTotalPhysicalMemorySize` and `com.sun.management.OperatingSystemMXBean.getFreePhysicalMemorySize`process.runtime.jvm.classes.unloadedNumber of classes unloaded since JVM start counter
system.memory.utilization1process.runtime.jvm.cpu.utilizationRecent cpu utilization for the process gauge System memory utilization, see `com.sun.management.OperatingSystemMXBean.getTotalPhysicalMemorySize` and `com.sun.management.OperatingSystemMXBean.getFreePhysicalMemorySize`. Report `0%` if no physical memory is discovered by the JVM.
system.paging.usageBystate`used`, `free`see `com.sun.management.OperatingSystemMXBean.getFreeSwapSpaceSize` and `com.sun.management.OperatingSystemMXBean.getTotalSwapSpaceSize`process.runtime.jvm.gc.durationDuration of JVM garbage collection actions histogramaction
gc		end of minor GC...
G1 Young Generation...
system.paging.utilization1see `com.sun.management.OperatingSystemMXBean.getFreeSwapSpaceSize` and `com.sun.management.OperatingSystemMXBean.getTotalSwapSpaceSize`. Report `0%` if no swap memory is discovered by the JVM.process.runtime.jvm.memory.committedMeasure of memory committed gaugepool
type		CodeHeap 'non-nmethods', CodeHeap 'non-profiled nmethods', CodeHeap + 'profiled nmethods', Compressed Class Space, G1 Eden Space, G1..., Metaspace
heap, non_heap +
process.cpu.load1process.runtime.jvm.memory.initMeasure of initial memory requested gaugepool
type		CodeHeap 'non-nmethods', CodeHeap 'non-profiled nmethods', CodeHeap + 'profiled nmethods', Compressed Class Space, G1 Eden Space, G1..., Metaspace
heap, non_heap +
process.runtime.jvm.memory.limitMeasure of max obtainable memory gaugepool
type		CodeHeap 'non-nmethods', CodeHeap 'non-profiled nmethods', CodeHeap + 'profiled nmethods', Compressed Class Space, G1 Eden Space, G1..., Metaspace
heap, non_heap +
process.runtime.jvm.memory.usageMeasure of memory used gaugepool
type		CodeHeap 'non-nmethods', CodeHeap 'non-profiled nmethods', CodeHeap + 'profiled nmethods', Compressed Class Space, G1 Eden Space, G1..., Metaspace
heap, non_heap +
process.runtime.jvm.memory.usage_after_last_gcMeasure of memory used after the most recent garbage collection event on this pool gaugepool
type		CodeHeap 'non-nmethods', CodeHeap 'G1 Eden Space, G1 Old Gen, G1 Survivor + Space
heap, non_heap +
process.runtime.jvm.system.cpu.load.1mAverage CPU load of the whole system for the last minute gauge Process CPU load. See `com.sun.management.OperatingSystemMXBean.getProcessCpuLoad`
process.cpu.timensprocess.runtime.jvm.system.cpu.utilizationRecent cpu utilization for the whole system gauge Process CPU time. See `com.sun.management.OperatingSystemMXBean.getProcessCpuTime`
process.runtime.jvm.threads.countNumber of executing threads gaugedaemontrue, false
+ ## Jenkins Security Metrics -| Metrics | Unit | Label / attribute key | Label / attribute value | Description | +| Metrics | Unit | Attribute Key | Attribute value | Description | |----------------------------------|-------|-----------------------|-------------------------|------------------------| | login | 1 | | | Login count | | login_success | 1 | | | Successful login count |