Package org.axonframework.micrometer

Class EventProcessorLatencyMonitor

java.lang.Object

org.axonframework.micrometer.EventProcessorLatencyMonitor

All Implemented Interfaces:

MessageMonitor<EventMessage<?>>

public class EventProcessorLatencyMonitor
extends Object
implements MessageMonitor<EventMessage<?>>

A MessageMonitor implementation dedicated to EventMessages.

This monitor defines the latency between the EventMessage.getTimestamp() and the Clock.wallTime(). Doing so, it depicts the latency from when an event was published compared to when an EventProcessor processes the event to clarify how far behind an EventProcessor is.

Do note that a replay (as triggered through StreamingEventProcessor.resetTokens(), for example) will cause this metric to bump up due to the processor handling old events.

Since:

4.1

Author:

Marijn van Zelst, Ivan Dugalic, Allard Buijze

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EventProcessorLatencyMonitor.Builder	Builder class to instantiate a EventProcessorLatencyMonitor.

Nested classes/interfaces inherited from interface org.axonframework.monitoring.MessageMonitor

MessageMonitor.MonitorCallback

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	EventProcessorLatencyMonitor(EventProcessorLatencyMonitor.Builder builder)	Instantiate a EventProcessorLatencyMonitor based on the fields contained in the EventProcessorLatencyMonitor.Builder.

Method Summary

Modifier and Type	Method	Description
static EventProcessorLatencyMonitor.Builder	builder()	Instantiate a Builder to be able to create a EventProcessorLatencyMonitor.
static EventProcessorLatencyMonitor	buildMonitor(String meterNamePrefix, io.micrometer.core.instrument.MeterRegistry meterRegistry)	Deprecated. in favor of using the builder()
static EventProcessorLatencyMonitor	buildMonitor(String meterNamePrefix, io.micrometer.core.instrument.MeterRegistry meterRegistry, Function<Message<?>,Iterable<io.micrometer.core.instrument.Tag>> tagsBuilder)	Deprecated. in favor of using the builder()
MessageMonitor.MonitorCallback	onMessageIngested(EventMessage<?> message)	Takes a message and returns a callback that should be used to inform the message monitor about the result of processing the message

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.axonframework.monitoring.MessageMonitor

onMessagesIngested

Constructor Details

EventProcessorLatencyMonitor

protected EventProcessorLatencyMonitor(EventProcessorLatencyMonitor.Builder builder)

Instantiate a EventProcessorLatencyMonitor based on the fields contained in the EventProcessorLatencyMonitor.Builder.

Will assert that the meterNamePrefix and MeterRegistry are not null and will throw an AxonConfigurationException if this is the case.

Parameters:

builder - the EventProcessorLatencyMonitor.Builder used to instantiate a EventProcessorLatencyMonitor instance

Method Details

builder

public static EventProcessorLatencyMonitor.Builder builder()

Instantiate a Builder to be able to create a EventProcessorLatencyMonitor.

The tagsBuilder is defaulted to a Function returning Tags.empty() and the Clock to a a Clock.SYSTEM. The meterNamePrefix and MeterRegistry are hard requirements and as such should be provided.

Returns:

a Builder to be able to create a EventProcessorLatencyMonitor

buildMonitor

@Deprecated
public static EventProcessorLatencyMonitor buildMonitor(String meterNamePrefix,
 io.micrometer.core.instrument.MeterRegistry meterRegistry)

Deprecated.

in favor of using the builder()

Build an EventProcessorLatencyMonitor

Parameters:

meterNamePrefix - the prefix for the meter name that will be created in the given meterRegistry

meterRegistry - the meter registry used to create and register the meters

Returns:

the created EventProcessorLatencyMonitor

buildMonitor

@Deprecated
public static EventProcessorLatencyMonitor buildMonitor(String meterNamePrefix,
 io.micrometer.core.instrument.MeterRegistry meterRegistry,
 Function<Message<?>,Iterable<io.micrometer.core.instrument.Tag>> tagsBuilder)

Deprecated.

in favor of using the builder()

Build an EventProcessorLatencyMonitor.

Parameters:

meterNamePrefix - the prefix for the meter name that will be created in the given meterRegistry

meterRegistry - the meter registry used to create and register the meters

tagsBuilder - the function used to construct the list of micrometer Tag, based on the ingested message

Returns:

the created EventProcessorLatencyMonitor

onMessageIngested

public MessageMonitor.MonitorCallback onMessageIngested(@Nonnull
 EventMessage<?> message)

Description copied from interface: MessageMonitor

Takes a message and returns a callback that should be used to inform the message monitor about the result of processing the message

Specified by:

onMessageIngested in interface MessageMonitor<EventMessage<?>>

Parameters:

message - the message to monitor

Returns:

the callback