org.axonframework.micrometer

Class MessageTimerMonitor

java.lang.Object

org.axonframework.micrometer.MessageTimerMonitor

All Implemented Interfaces:

MessageMonitor<Message<?>>

public class MessageTimerMonitor
extends Object
implements MessageMonitor<Message<?>>

Times allTimer messages, successful and failed messages

Since:

4.1

Author:

Marijn van Zelst, Ivan Dugalic

Nested Class Summary

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

MessageMonitor.MonitorCallback

Method Summary

Modifier and Type	Method and Description
static MessageTimerMonitor	buildMonitor(String meterNamePrefix, io.micrometer.core.instrument.MeterRegistry meterRegistry) Creates a message timer monitor
static MessageTimerMonitor	buildMonitor(String meterNamePrefix, io.micrometer.core.instrument.MeterRegistry meterRegistry, io.micrometer.core.instrument.Clock clock) Creates a message timer monitor.
static MessageTimerMonitor	buildMonitor(String meterNamePrefix, io.micrometer.core.instrument.MeterRegistry meterRegistry, io.micrometer.core.instrument.Clock clock, Function<Message<?>,Iterable<io.micrometer.core.instrument.Tag>> tagsBuilder) Creates a message timer monitor.
static MessageTimerMonitor	buildMonitor(String meterNamePrefix, io.micrometer.core.instrument.MeterRegistry meterRegistry, Function<Message<?>,Iterable<io.micrometer.core.instrument.Tag>> tagsBuilder) Creates a message timer monitor
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

Method Detail

buildMonitor

public static MessageTimerMonitor buildMonitor(String meterNamePrefix,
                                               io.micrometer.core.instrument.MeterRegistry meterRegistry)

Creates a message timer monitor

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 message timer monitor

buildMonitor

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

Creates a message timer monitor

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 message timer monitor

buildMonitor

public static MessageTimerMonitor buildMonitor(String meterNamePrefix,
                                               io.micrometer.core.instrument.MeterRegistry meterRegistry,
                                               io.micrometer.core.instrument.Clock clock)

Creates a message timer monitor.

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

clock - The clock used to measure the process time per message

Returns:

The message timer monitor

buildMonitor

public static MessageTimerMonitor buildMonitor(String meterNamePrefix,
                                               io.micrometer.core.instrument.MeterRegistry meterRegistry,
                                               io.micrometer.core.instrument.Clock clock,
                                               Function<Message<?>,Iterable<io.micrometer.core.instrument.Tag>> tagsBuilder)

Creates a message timer monitor.

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

clock - The clock used to measure the process time per message

Returns:

The message timer monitor

onMessageIngested

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