Package io.jmix.core.observation

Class DataObservationSupport

java.lang.Object

io.jmix.core.observation.DataObservationSupport

@Component("core_DataObservationSupport")
@NullMarked
public class DataObservationSupport
extends Object

Support class for observing data operations such as entity loading, counting, value loading, and entity saving.

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.core.data-observation-enabled property in the application's configuration.

See Also:

• CoreProperties.isDataObservationEnabled()

Field Summary

Fields

Modifier and Type	Field	Description
protected Metadata	metadata
protected boolean	observationEnabled
protected io.micrometer.observation.ObservationRegistry	observationRegistry

Constructor Summary

Constructors

Constructor	Description
DataObservationSupport(CoreProperties coreProperties)

Method Summary

Modifier and Type	Method	Description
protected void	addQueryHighCardinalityIfExist(io.micrometer.observation.Observation observation, @Nullable DataLoadContextQuery query, Supplier<String> queryGetter)
io.micrometer.observation.Observation	createEntitiesSaveObservation(SaveContext context, String store)
io.micrometer.observation.Observation	createEntityCountObservation(MetaClass metaClass, @Nullable LoadContext.Query query)
io.micrometer.observation.Observation	createEntityListLoadObservation(MetaClass metaClass, @Nullable LoadContext.Query query)
io.micrometer.observation.Observation	createEntityLoadObservation(MetaClass metaClass, @Nullable LoadContext.Query query)
io.micrometer.observation.Observation	createValuesCountObservation(ValueLoadContext context)
io.micrometer.observation.Observation	createValuesLoadObservation(ValueLoadContext context)
protected boolean	isObservationAvailable()

Methods inherited from class java.lang.Object

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

Field Details

metadata

@Autowired
protected Metadata metadata

observationRegistry

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

observationEnabled

protected boolean observationEnabled

Constructor Details

DataObservationSupport

public DataObservationSupport(CoreProperties coreProperties)

Method Details

createEntityLoadObservation

public io.micrometer.observation.Observation createEntityLoadObservation(MetaClass metaClass,
 @Nullable LoadContext.Query query)

createEntityListLoadObservation

public io.micrometer.observation.Observation createEntityListLoadObservation(MetaClass metaClass,
 @Nullable LoadContext.Query query)

createEntityCountObservation

public io.micrometer.observation.Observation createEntityCountObservation(MetaClass metaClass,
 @Nullable LoadContext.Query query)

createValuesLoadObservation

public io.micrometer.observation.Observation createValuesLoadObservation(ValueLoadContext context)

createValuesCountObservation

public io.micrometer.observation.Observation createValuesCountObservation(ValueLoadContext context)

createEntitiesSaveObservation

public io.micrometer.observation.Observation createEntitiesSaveObservation(SaveContext context,
 String store)

addQueryHighCardinalityIfExist

protected void addQueryHighCardinalityIfExist(io.micrometer.observation.Observation observation,
 @Nullable DataLoadContextQuery query,
 Supplier<String> queryGetter)

isObservationAvailable

protected boolean isObservationAvailable()