Class JvmMemoryPoolAllocationMetrics

java.lang.Object

io.prometheus.metrics.instrumentation.jvm.JvmMemoryPoolAllocationMetrics

public class JvmMemoryPoolAllocationMetrics
extends Object

JVM memory allocation metrics. The JvmMemoryPoolAllocationMetrics are registered as part of the JvmMetrics like this:

JvmMetrics.builder().register();

However, if you want only the JvmMemoryPoolAllocationMetrics you can also register them directly:

JvmMemoryAllocationMetrics.builder().register();

Example metrics being exported:

# HELP jvm_memory_pool_allocated_bytes_total Total bytes allocated in a given JVM memory pool. Only updated after GC, not continuously.
# TYPE jvm_memory_pool_allocated_bytes_total counter
jvm_memory_pool_allocated_bytes_total{pool="Code Cache"} 4336448.0
jvm_memory_pool_allocated_bytes_total{pool="Compressed Class Space"} 875016.0
jvm_memory_pool_allocated_bytes_total{pool="Metaspace"} 7480456.0
jvm_memory_pool_allocated_bytes_total{pool="PS Eden Space"} 1.79232824E8
jvm_memory_pool_allocated_bytes_total{pool="PS Old Gen"} 1428888.0
jvm_memory_pool_allocated_bytes_total{pool="PS Survivor Space"} 4115280.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	JvmMemoryPoolAllocationMetrics.AllocationCountingNotificationListener
static class	JvmMemoryPoolAllocationMetrics.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final Labels	constLabels
private final List<GarbageCollectorMXBean>	garbageCollectorBeans
private static final String	JVM_MEMORY_POOL_ALLOCATED_BYTES_TOTAL

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JvmMemoryPoolAllocationMetrics(List<GarbageCollectorMXBean> garbageCollectorBeans, Labels constLabels)

Method Summary

Modifier and Type	Method	Description
static JvmMemoryPoolAllocationMetrics.Builder	builder()
static JvmMemoryPoolAllocationMetrics.Builder	builder(PrometheusProperties config)
private void	register(PrometheusRegistry registry)

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

JVM_MEMORY_POOL_ALLOCATED_BYTES_TOTAL

private static final String JVM_MEMORY_POOL_ALLOCATED_BYTES_TOTAL

See Also:

• Constant Field Values

garbageCollectorBeans

private final List<GarbageCollectorMXBean> garbageCollectorBeans

constLabels

private final Labels constLabels

Constructor Details

JvmMemoryPoolAllocationMetrics

private JvmMemoryPoolAllocationMetrics(List<GarbageCollectorMXBean> garbageCollectorBeans,
 Labels constLabels)

Method Details

register

private void register(PrometheusRegistry registry)

builder

public static JvmMemoryPoolAllocationMetrics.Builder builder()

builder

public static JvmMemoryPoolAllocationMetrics.Builder builder(PrometheusProperties config)