Package io.opentelemetry.instrumentation.runtimemetrics.java8

Class GarbageCollector

java.lang.Object

io.opentelemetry.instrumentation.runtimemetrics.java8.GarbageCollector

public final class GarbageCollector
extends Object

Registers instruments that generate metrics about JVM garbage collection.

Example usage:

 GarbageCollector.registerObservers(GlobalOpenTelemetry.get());
 

Example metrics being exported:

   process.runtime.jvm.gc.duration{gc="G1 Young Generation",action="end of minor GC"} 0.022
 

In case you enable the preview of stable JVM semantic conventions (e.g. by setting the otel.semconv-stability.opt-in system property to jvm), the metrics being exported will follow the most recent JVM semantic conventions. This is how the example above looks when stable JVM semconv is enabled:

   jvm.gc.duration{jvm.gc.name="G1 Young Generation",jvm.gc.action="end of minor GC"} 0.022
 

Method Summary

Modifier and Type	Method	Description
static List<AutoCloseable>	registerObservers(io.opentelemetry.api.OpenTelemetry openTelemetry)	Register observers for java runtime memory metrics.

Methods inherited from class java.lang.Object

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

Method Details

registerObservers

public static List<AutoCloseable> registerObservers(io.opentelemetry.api.OpenTelemetry openTelemetry)

Register observers for java runtime memory metrics.