Package io.jmix.flowui.observation

Class UiObservationSupport

java.lang.Object

io.jmix.flowui.observation.UiObservationSupport

@Component("flowui_UiObservationSupport")
public class UiObservationSupport
extends Object

Support class for observing UI events such as view lifecycle events and action executions.

This class uses an ObservationRegistry if observation functionality is enabled in the application configuration.

Observation functionality can be turned on or off using the jmix.ui.ui-observation-enabled property in the application's configuration.

See Also:

• UiProperties.isUiObservationEnabled()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ACTION_CONTEXTUAL_NAME	Human-readable contextual name passed to the Observation of action executions.
static final String	ACTION_ID_TAG	Low-cardinality tag key carrying the action's id on action-execution observations.
static final String	ACTION_OBSERVATION_NAME
static final String	DATA_LOADER_CONTEXTUAL_NAME	Human-readable contextual name passed to the Observation of data loader lifecycle phases.
static final String	DATA_LOADER_OBSERVATION_NAME
static final String	FRAGMENT_CLASS_TAG	Low-cardinality tag key carrying the FQN of the fragment's class.
static final String	FRAGMENT_CONTEXTUAL_NAME	Human-readable contextual name passed to the Observation of fragment lifecycle phases.
static final String	FRAGMENT_ID_TAG	Low-cardinality tag key carrying the enclosing fragment's id.
static final String	FRAGMENT_OBSERVATION_NAME
static final String	FULL_LOADER_ID_TAG	High-cardinality span attribute key preserving the original loader id when LOADER_ID_TAG collapses to the sentinel.
protected static final String	GENERATED_LOADER_ID_SENTINEL	Sentinel for the low-cardinality loader.id tag when the loader carries an auto-generated id (prefix generated_).
protected LegacyUiTimerSupport	legacyUiTimerSupport
static final String	LIFECYCLE_NAME_TAG	Tag key carrying the modern-schema lifecycle phase name on view / fragment / data-loader observations.
static final String	LOADER_ID_TAG	Low-cardinality tag key carrying the data loader's id (or GENERATED_LOADER_ID_SENTINEL).
static final String	NOT_AVAILABLE	Sentinel value placed into low-cardinality tags (VIEW_ID_TAG, FRAGMENT_ID_TAG, TARGET_ID_TAG) when the underlying id cannot be resolved (view/fragment/target absent or without an explicit id).
static final String	OBSERVATION_NAME_PREFIX	Shared prefix of every jmix.ui.* observation/metric name produced by this support class.
protected boolean	observationEnabled
protected io.micrometer.observation.ObservationRegistry	observationRegistry
static final String	TARGET_ID_TAG	Low-cardinality tag key carrying the target component's id on action-execution observations.
static final String	VIEW_CLASS_TAG	Low-cardinality tag key carrying the FQN of the view's class.
static final String	VIEW_CONTEXTUAL_NAME	Human-readable contextual name passed to the Observation of view lifecycle phases.
static final String	VIEW_ID_TAG	Low-cardinality tag key carrying the enclosing view's id.
static final String	VIEW_OBSERVATION_NAME

Constructor Summary

Constructors

Constructor	Description
UiObservationSupport(UiProperties uiProperties)

Method Summary

Modifier and Type	Method	Description
protected io.micrometer.observation.Observation	buildDataLoaderObservation(DataLoader loader, DataLoaderLifeCycle lifecycle)	Builds the data loader Observation lazily — observation availability is checked before invoking DataLoader.getObservationInfoProvider(), since that provider can walk the UI tree to resolve fragment/view context (see R8) and should not run when observation is disabled.
protected io.micrometer.observation.Observation	buildFragmentLifecycleObservation(FragmentObservationInfo info, FragmentLifecycle lifecycle)
protected io.micrometer.observation.Observation	buildViewLifecycleObservation(View<?> view, ViewLifecycle lifecycle)
io.micrometer.observation.Observation	createActionExecutionObservation(Action action, @Nullable com.vaadin.flow.component.Component invocationSource)
protected boolean	isObservationAvailable()
void	observeDataLoader(DataLoader loader, DataLoaderLifeCycle phase, Runnable action)	Records monitoring data for a void DataLoader lifecycle phase.
<T> T	observeDataLoader(DataLoader loader, DataLoaderLifeCycle phase, Supplier<T> action)
void	observeFragmentLifecycle(Fragment<?> fragment, FragmentLifecycle phase, Runnable action)	Records monitoring data for a void Fragment lifecycle phase.
<T> T	observeFragmentLifecycle(Fragment<?> fragment, FragmentLifecycle phase, Supplier<T> action)	Records monitoring data for a value-returning Fragment lifecycle phase.
<T> T	observeFragmentLifecycle(FragmentObservationInfo info, FragmentLifecycle phase, Supplier<T> action)
void	observeViewLifecycle(View<?> view, ViewLifecycle phase, Runnable action)	Records monitoring data for a void View lifecycle phase.
<T> T	observeViewLifecycle(View<?> view, ViewLifecycle phase, Supplier<T> action)

Methods inherited from class java.lang.Object

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

Field Details

OBSERVATION_NAME_PREFIX

public static final String OBSERVATION_NAME_PREFIX

Shared prefix of every jmix.ui.* observation/metric name produced by this support class.

See Also:

• Constant Field Values

VIEW_OBSERVATION_NAME

public static final String VIEW_OBSERVATION_NAME

See Also:

• Constant Field Values

FRAGMENT_OBSERVATION_NAME

public static final String FRAGMENT_OBSERVATION_NAME

See Also:

• Constant Field Values

ACTION_OBSERVATION_NAME

public static final String ACTION_OBSERVATION_NAME

See Also:

• Constant Field Values

DATA_LOADER_OBSERVATION_NAME

public static final String DATA_LOADER_OBSERVATION_NAME

See Also:

• Constant Field Values

VIEW_CONTEXTUAL_NAME

public static final String VIEW_CONTEXTUAL_NAME

Human-readable contextual name passed to the Observation of view lifecycle phases.

See Also:

• Constant Field Values

FRAGMENT_CONTEXTUAL_NAME

public static final String FRAGMENT_CONTEXTUAL_NAME

Human-readable contextual name passed to the Observation of fragment lifecycle phases.

See Also:

• Constant Field Values

DATA_LOADER_CONTEXTUAL_NAME

public static final String DATA_LOADER_CONTEXTUAL_NAME

Human-readable contextual name passed to the Observation of data loader lifecycle phases.

See Also:

• Constant Field Values

ACTION_CONTEXTUAL_NAME

public static final String ACTION_CONTEXTUAL_NAME

Human-readable contextual name passed to the Observation of action executions.

See Also:

• Constant Field Values

LIFECYCLE_NAME_TAG

public static final String LIFECYCLE_NAME_TAG

Tag key carrying the modern-schema lifecycle phase name on view / fragment / data-loader observations. Acts as the marker that distinguishes modern Observation meters from the legacy Timer-based schema; the legacy stack uses it to suppress modern Timer registrations under the same jmix.ui.* names (see LegacyUiTimerSupport).

See Also:

• Constant Field Values

VIEW_ID_TAG

public static final String VIEW_ID_TAG

Low-cardinality tag key carrying the enclosing view's id.

See Also:

• Constant Field Values

VIEW_CLASS_TAG

public static final String VIEW_CLASS_TAG

Low-cardinality tag key carrying the FQN of the view's class.

See Also:

• Constant Field Values

FRAGMENT_ID_TAG

public static final String FRAGMENT_ID_TAG

Low-cardinality tag key carrying the enclosing fragment's id.

See Also:

• Constant Field Values

FRAGMENT_CLASS_TAG

public static final String FRAGMENT_CLASS_TAG

Low-cardinality tag key carrying the FQN of the fragment's class.

See Also:

• Constant Field Values

LOADER_ID_TAG

public static final String LOADER_ID_TAG

Low-cardinality tag key carrying the data loader's id (or GENERATED_LOADER_ID_SENTINEL).

See Also:

• Constant Field Values

FULL_LOADER_ID_TAG

public static final String FULL_LOADER_ID_TAG

High-cardinality span attribute key preserving the original loader id when LOADER_ID_TAG collapses to the sentinel.

See Also:

• Constant Field Values

ACTION_ID_TAG

public static final String ACTION_ID_TAG

Low-cardinality tag key carrying the action's id on action-execution observations.

See Also:

• Constant Field Values

TARGET_ID_TAG

public static final String TARGET_ID_TAG

Low-cardinality tag key carrying the target component's id on action-execution observations.

See Also:

• Constant Field Values

NOT_AVAILABLE

public static final String NOT_AVAILABLE

Sentinel value placed into low-cardinality tags (VIEW_ID_TAG, FRAGMENT_ID_TAG, TARGET_ID_TAG) when the underlying id cannot be resolved (view/fragment/target absent or without an explicit id). The tag is added unconditionally so the Prometheus meter for a given metric name always carries the same set of tag keys — otherwise conditionally-added tags make PrometheusMeterRegistry reject one of the registrations and silently drop a slice of the data.

See Also:

• Constant Field Values

GENERATED_LOADER_ID_SENTINEL

protected static final String GENERATED_LOADER_ID_SENTINEL

Sentinel for the low-cardinality loader.id tag when the loader carries an auto-generated id (prefix generated_). Aggregates all anonymous loaders into a single time-series; the original id is preserved as a high-cardinality full_loader_id attribute on the span.

See Also:

• Constant Field Values

observationRegistry

@Autowired(required=false)
protected io.micrometer.observation.ObservationRegistry observationRegistry

legacyUiTimerSupport

@Autowired
protected LegacyUiTimerSupport legacyUiTimerSupport

observationEnabled

protected boolean observationEnabled

Constructor Details

UiObservationSupport

public UiObservationSupport(UiProperties uiProperties)

Method Details

observeDataLoader

public void observeDataLoader(DataLoader loader,
 DataLoaderLifeCycle phase,
 Runnable action)

Records monitoring data for a void DataLoader lifecycle phase.

observeDataLoader

public <T> T observeDataLoader(DataLoader loader,
 DataLoaderLifeCycle phase,
 Supplier<T> action)

See Also:

• observeDataLoader(DataLoader, DataLoaderLifeCycle, Runnable)

buildDataLoaderObservation

protected io.micrometer.observation.Observation buildDataLoaderObservation(DataLoader loader,
 DataLoaderLifeCycle lifecycle)

Builds the data loader Observation lazily — observation availability is checked before invoking DataLoader.getObservationInfoProvider(), since that provider can walk the UI tree to resolve fragment/view context (see R8) and should not run when observation is disabled.

observeViewLifecycle

public void observeViewLifecycle(View<?> view,
 ViewLifecycle phase,
 Runnable action)

Records monitoring data for a void View lifecycle phase.

observeViewLifecycle

public <T> T observeViewLifecycle(View<?> view,
 ViewLifecycle phase,
 Supplier<T> action)

See Also:

• observeViewLifecycle(View, ViewLifecycle, Runnable)

buildViewLifecycleObservation

protected io.micrometer.observation.Observation buildViewLifecycleObservation(View<?> view,
 ViewLifecycle lifecycle)

observeFragmentLifecycle

public void observeFragmentLifecycle(Fragment<?> fragment,
 FragmentLifecycle phase,
 Runnable action)

Records monitoring data for a void Fragment lifecycle phase.

observeFragmentLifecycle

public <T> T observeFragmentLifecycle(Fragment<?> fragment,
 FragmentLifecycle phase,
 Supplier<T> action)

Records monitoring data for a value-returning Fragment lifecycle phase.

See Also:

• observeFragmentLifecycle(Fragment, FragmentLifecycle, Runnable)

observeFragmentLifecycle

public <T> T observeFragmentLifecycle(FragmentObservationInfo info,
 FragmentLifecycle phase,
 Supplier<T> action)

See Also:

• observeFragmentLifecycle(Fragment, FragmentLifecycle, Runnable)

buildFragmentLifecycleObservation

protected io.micrometer.observation.Observation buildFragmentLifecycleObservation(FragmentObservationInfo info,
 FragmentLifecycle lifecycle)

createActionExecutionObservation

public io.micrometer.observation.Observation createActionExecutionObservation(Action action,
 @Nullable com.vaadin.flow.component.Component invocationSource)

isObservationAvailable

protected boolean isObservationAvailable()