Package io.opentelemetry.instrumentation.runtimetelemetry

Class RuntimeTelemetry

java.lang.Object

io.opentelemetry.instrumentation.runtimetelemetry.RuntimeTelemetry

All Implemented Interfaces:

AutoCloseable

public final class RuntimeTelemetry
extends Object
implements AutoCloseable

The entry point class for runtime telemetry support using JMX (Java 8+) and JFR (Java 17+).

Method Summary

Modifier and Type	Method	Description
static RuntimeTelemetryBuilder	builder(io.opentelemetry.api.OpenTelemetry openTelemetry)	Create a builder for configuring RuntimeTelemetry.
void	close()	Stop recording metrics.
static RuntimeTelemetry	create(io.opentelemetry.api.OpenTelemetry openTelemetry)	Create and start RuntimeTelemetry.

Methods inherited from class java.lang.Object

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

Method Details

create

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

Create and start RuntimeTelemetry.

Listens for select JMX beans (and JFR events on Java 17+), 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 RuntimeTelemetryBuilder builder(io.opentelemetry.api.OpenTelemetry openTelemetry)

Create a builder for configuring RuntimeTelemetry.

Parameters:

openTelemetry - the OpenTelemetry instance used to record telemetry

close

public void close()

Stop recording metrics.

Specified by:

close in interface AutoCloseable