Package com.vaadin.observability.micrometer

Class ObservabilityKit

java.lang.Object

com.vaadin.observability.micrometer.ObservabilityKit

public final class ObservabilityKit
extends Object

Programmatic bootstrap for standalone (non-Spring) deployments. Call install(MeterRegistry, ObservabilitySettings) once at startup; the SPI-loaded MetricsServiceInitListener reads the stored registry and settings when the VaadinService initializes.

Method Summary

Modifier and Type	Method	Description
static io.micrometer.core.instrument.MeterRegistry	getActiveMeterRegistry()	The registry instrumentation is currently publishing to, or null if instrumentation has not been bound.
static RecentClientErrors	getRecentClientErrors()	Gets the retained browser errors, or null when any of the three settings they need was off — the in-browser collector, insights, or error instrumentation.
static RecentInteractions	getRecentInteractions()	The recent-interactions buffer instrumentation is currently recording into, or null if interaction backtracking has not been bound.
static RecentQueries	getRecentQueries()	Gets the retained data provider queries, or null when the query collector was not registered.
static void	install(io.micrometer.core.instrument.MeterRegistry meterRegistry, ObservabilitySettings settings)
static void	install(io.micrometer.core.instrument.MeterRegistry meterRegistry, io.micrometer.observation.ObservationRegistry observationRegistry, ObservabilitySettings settings)

Methods inherited from class java.lang.Object

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

Method Details

install

public static void install(io.micrometer.core.instrument.MeterRegistry meterRegistry,
 ObservabilitySettings settings)

install

public static void install(io.micrometer.core.instrument.MeterRegistry meterRegistry,
 io.micrometer.observation.ObservationRegistry observationRegistry,
 ObservabilitySettings settings)

getActiveMeterRegistry

public static io.micrometer.core.instrument.MeterRegistry getActiveMeterRegistry()

The registry instrumentation is currently publishing to, or null if instrumentation has not been bound. Read by the dev-mode Copilot metrics panel.

Returns:

the active meter registry, or null

getRecentQueries

public static RecentQueries getRecentQueries()

Gets the retained data provider queries, or null when the query collector was not registered.

Returns:

the query buffer, or null

getRecentClientErrors

public static RecentClientErrors getRecentClientErrors()

Gets the retained browser errors, or null when any of the three settings they need was off — the in-browser collector, insights, or error instrumentation.

Returns:

the browser-error buffer, or null

getRecentInteractions

public static RecentInteractions getRecentInteractions()

The recent-interactions buffer instrumentation is currently recording into, or null if interaction backtracking has not been bound. Read by the insights endpoint.

Returns:

the active recent-interactions buffer, or null