Package org.axonframework.extension.metrics.dropwizard

Class EventProcessorLatencyMonitor

java.lang.Object

org.axonframework.extension.metrics.dropwizard.EventProcessorLatencyMonitor

All Implemented Interfaces:

io.dropwizard.metrics5.Metric, io.dropwizard.metrics5.MetricSet, MessageMonitor<EventMessage>

public class EventProcessorLatencyMonitor
extends Object
implements MessageMonitor<EventMessage>, io.dropwizard.metrics5.MetricSet

A MessageMonitor implementation dedicated to EventMessages.

This monitor defines the latency between the EventMessage.timestamp() and the Clock.instant(). 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:

3.0

Author:

Marijn van Zelst, Allard Buijze

Nested Class Summary

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

MessageMonitor.MonitorCallback

Constructor Summary

Constructors

Constructor	Description
EventProcessorLatencyMonitor()	Construct an EventProcessorLatencyMonitor using a Clock.systemUTC().
EventProcessorLatencyMonitor(Clock clock)	Construct an EventProcessorLatencyMonitor using the given clock.

Method Summary

Modifier and Type	Method	Description
Map<io.dropwizard.metrics5.MetricName,io.dropwizard.metrics5.Metric>	getMetrics()
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.messaging.monitoring.MessageMonitor

onMessagesIngested

Constructor Details

EventProcessorLatencyMonitor

public EventProcessorLatencyMonitor()

Construct an EventProcessorLatencyMonitor using a Clock.systemUTC().

EventProcessorLatencyMonitor

public EventProcessorLatencyMonitor(Clock clock)

Construct an EventProcessorLatencyMonitor using the given clock.

Parameters:

clock - defines the Clock used by this MessageMonitor implementation

Method Details

onMessageIngested

public MessageMonitor.MonitorCallback onMessageIngested(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

getMetrics

public Map<io.dropwizard.metrics5.MetricName,io.dropwizard.metrics5.Metric> getMetrics()

Specified by:

getMetrics in interface io.dropwizard.metrics5.MetricSet