Package org.springframework.modulith.observability.support

Class CrossModuleEventCounterFactory

java.lang.Object

org.springframework.modulith.observability.support.CrossModuleEventCounterFactory

All Implemented Interfaces:

ModulithEventMetrics

public class CrossModuleEventCounterFactory
extends Object
implements ModulithEventMetrics

A factory to create Counter.Builder instances for Counters eventually. Target for dependency injection via the ModulithEventMetricsCustomizer interface to allow users to augment the counters with additional information.

Since:

1.4

Author:

Oliver Drotbohm, Marcin Grzejszczak

Constructor Summary

Constructors

Constructor	Description
CrossModuleEventCounterFactory()

Method Summary

Modifier and Type	Method	Description
(package private) io.micrometer.core.instrument.Counter.Builder	createCounterBuilder(Object event)	Creates a Counter.Builder instance for the given event applying registered customizers.
<T> CrossModuleEventCounterFactory	customize(Class<T> type, BiConsumer<T,io.micrometer.core.instrument.Counter.Builder> consumer)	Customizes a Counter.Builder to eventually produce a Counter for the event of the given type.
<T> ModulithEventMetrics	customize(Class<T> type, Function<T,io.micrometer.core.instrument.Counter.Builder> factory)	Customizes the creation of a Counter.Builder for events of the given type.

Methods inherited from class java.lang.Object

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

Constructor Details

CrossModuleEventCounterFactory

public CrossModuleEventCounterFactory()

Method Details

createCounterBuilder

io.micrometer.core.instrument.Counter.Builder createCounterBuilder(Object event)

Creates a Counter.Builder instance for the given event applying registered customizers.

Parameters:

event - must not be null.

Returns:

will never be null.

customize

public <T> ModulithEventMetrics customize(Class<T> type,
 Function<T,io.micrometer.core.instrument.Counter.Builder> factory)

Description copied from interface: ModulithEventMetrics

Customizes the creation of a Counter.Builder for events of the given type. The instances created will still be subject to customizations registered via ModulithEventMetrics.customize(Class, BiConsumer).

Specified by:

customize in interface ModulithEventMetrics

Parameters:

type - must not be null.

factory - must not be null.

Returns:

will never be null.

customize

public <T> CrossModuleEventCounterFactory customize(Class<T> type,
 BiConsumer<T,io.micrometer.core.instrument.Counter.Builder> consumer)

Description copied from interface: ModulithEventMetrics

Customizes a Counter.Builder to eventually produce a Counter for the event of the given type. The Counter.Builder will have been set up named after the fully-qualified type name. To customize the creation, also call ModulithEventMetrics.customize(Class, Function).

Specified by:

customize in interface ModulithEventMetrics

Type Parameters:

T - the type of the event.

Parameters:

type - must not be null.

consumer - must not be null.

Returns:

will never be null.

See Also:

• ModulithEventMetrics.customize(Class, Function)