Package io.prometheus.metrics.instrumentation.jvm

Class JvmGarbageCollectorMetrics

java.lang.Object

io.prometheus.metrics.instrumentation.jvm.JvmGarbageCollectorMetrics

public class JvmGarbageCollectorMetrics
extends Object

JVM Garbage Collector metrics. The JvmGarbageCollectorMetrics are registered as part of the JvmMetrics like this:

 JvmMetrics.builder().register();
 

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

 JvmGarbageCollectorMetrics.builder().register();
 

Example metrics being exported:

 # HELP jvm_gc_collection_seconds Time spent in a given JVM garbage collector in seconds.
 # TYPE jvm_gc_collection_seconds summary
 jvm_gc_collection_seconds_count{gc="PS MarkSweep"} 0
 jvm_gc_collection_seconds_sum{gc="PS MarkSweep"} 0.0
 jvm_gc_collection_seconds_count{gc="PS Scavenge"} 0
 jvm_gc_collection_seconds_sum{gc="PS Scavenge"} 0.0
 

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JvmGarbageCollectorMetrics.Builder

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
private	JvmGarbageCollectorMetrics(List<GarbageCollectorMXBean> garbageCollectorBeans, PrometheusProperties config, Labels constLabels)

Method Summary

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

Methods inherited from class java.lang.Object

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

Field Details

JVM_GC_COLLECTION_SECONDS

private static final String JVM_GC_COLLECTION_SECONDS

See Also:

• Constant Field Values

config

private final PrometheusProperties config

garbageCollectorBeans

private final List<GarbageCollectorMXBean> garbageCollectorBeans

constLabels

private final Labels constLabels

Constructor Details

JvmGarbageCollectorMetrics

private JvmGarbageCollectorMetrics(List<GarbageCollectorMXBean> garbageCollectorBeans,
 PrometheusProperties config,
 Labels constLabels)

Method Details

register

private void register(PrometheusRegistry registry)

builder

public static JvmGarbageCollectorMetrics.Builder builder()

builder

public static JvmGarbageCollectorMetrics.Builder builder(PrometheusProperties config)