Package io.opentelemetry.instrumentation.runtimemetrics.java17

Class RuntimeMetrics

java.lang.Object

io.opentelemetry.instrumentation.runtimemetrics.java17.RuntimeMetrics

All Implemented Interfaces:

Closeable, AutoCloseable

public final class RuntimeMetrics
extends Object
implements Closeable

The entry point class for runtime metrics support using JFR and JMX.

Method Summary

Modifier and Type	Method	Description
static RuntimeMetricsBuilder	builder(io.opentelemetry.api.OpenTelemetry openTelemetry)	Create a builder for configuring RuntimeMetrics.
void	close()	Stop recording JFR events.
static RuntimeMetrics	create(io.opentelemetry.api.OpenTelemetry openTelemetry)	Create and start RuntimeMetrics, configured with the default JfrFeatures.

Methods inherited from class java.lang.Object

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

Method Details

create

public static RuntimeMetrics create(io.opentelemetry.api.OpenTelemetry openTelemetry)

Create and start RuntimeMetrics, configured with the default JfrFeatures.

Listens for select JFR events, extracts data, and records to various metrics. Recording will continue until close() is called.

Parameters:

openTelemetry - the OpenTelemetry instance used to record telemetry

builder

public static RuntimeMetricsBuilder builder(io.opentelemetry.api.OpenTelemetry openTelemetry)

Create a builder for configuring RuntimeMetrics.

Parameters:

openTelemetry - the OpenTelemetry instance used to record telemetry

close

public void close()

Stop recording JFR events.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable