org.axonframework.metrics

Class MessageTimerMonitor

java.lang.Object

org.axonframework.metrics.MessageTimerMonitor

All Implemented Interfaces:

com.codahale.metrics.Metric, com.codahale.metrics.MetricSet, MessageMonitor<Message<?>>

public class MessageTimerMonitor
extends Object
implements MessageMonitor<Message<?>>, com.codahale.metrics.MetricSet

A MessageMonitor which creates Timer instances for the overall, success, failure and ignored time an ingested Message takes.

Since:

3.0

Author:

Marijn van Zelst

Nested Class Summary

Nested Classes

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

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

MessageMonitor.MonitorCallback

Constructor Summary

Constructors

Modifier	Constructor and Description
	MessageTimerMonitor() Deprecated. in favor of the builder()
	MessageTimerMonitor(com.codahale.metrics.Clock clock) Deprecated. in favor of the builder()
protected	MessageTimerMonitor(MessageTimerMonitor.Builder builder) Instantiate a MessageTimerMonitor based on the fields contained in the MessageTimerMonitor.Builder.

Method Summary

Modifier and Type	Method and Description
static MessageTimerMonitor.Builder	builder() Instantiate a Builder to be able to create a MessageTimerMonitor.
Map<String,com.codahale.metrics.Metric>	getMetrics()
MessageMonitor.MonitorCallback	onMessageIngested(Message<?> 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 Detail

MessageTimerMonitor

protected MessageTimerMonitor(MessageTimerMonitor.Builder builder)

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

Parameters:

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

MessageTimerMonitor

@Deprecated
public MessageTimerMonitor()

Deprecated. in favor of the builder()

Creates a MessageTimerMonitor using a default clock

MessageTimerMonitor

@Deprecated
public MessageTimerMonitor(com.codahale.metrics.Clock clock)

Deprecated. in favor of the builder()

Creates a MessageTimerMonitor using the provided clock

Parameters:

clock - the clock used to measure the process time of each message

Method Detail

builder

public static MessageTimerMonitor.Builder builder()

Instantiate a Builder to be able to create a MessageTimerMonitor.

The Clock is defaulted to a Clock.defaultClock() and the reservoirFactory defaults to creating a ExponentiallyDecayingReservoir.

Returns:

a Builder to be able to create a MessageTimerMonitor

onMessageIngested

public MessageMonitor.MonitorCallback onMessageIngested(@Nonnull
                                                        Message<?> 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<Message<?>>

Parameters:

message - the message to monitor

Returns:

the callback

getMetrics

public Map<String,com.codahale.metrics.Metric> getMetrics()

Specified by:

getMetrics in interface com.codahale.metrics.MetricSet