Package org.axonframework.extension.metrics.micrometer

Class TagsUtil

java.lang.Object

org.axonframework.extension.metrics.micrometer.TagsUtil

public class TagsUtil
extends Object

Utility class for Micrometer tag management.

Contains static final fields which represent the micrometer tag KEY that should be consistent across different metrics, and functions responsible for creating the Micrometer Tags based on the Message that is ingested by a MessageMonitor.

Since:

4.4.0

Author:

Ivan Dugalic, Steven van Beelen

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MESSAGE_TYPE_TAG	The micrometer Tag key that represents Axon Framework's message type name.
static final Function<Message,Iterable<io.micrometer.core.instrument.Tag>>	MESSAGE_TYPE_TAGGER	A function for creating the Micrometer Tag based on the message type name.
static final Function<Message,Iterable<io.micrometer.core.instrument.Tag>>	METADATA_TAGGER	A function for creating the Micrometer Tags based on the message's metadata.
static final Function<Message,Iterable<io.micrometer.core.instrument.Tag>>	NO_OP	A function for creating no Micrometer Tags at all.
static final String	PROCESSOR_NAME_TAG	The micrometer Tag key that represents the Axon Framework's EventProcessor name.

Method Summary

Modifier and Type	Method	Description
static Function<Message,Iterable<io.micrometer.core.instrument.Tag>>	processorNameTag(String processorName)	A function for creating a Micrometer Tag based on the given processorName only, using the PROCESSOR_NAME_TAG key.
static Function<Message,Iterable<io.micrometer.core.instrument.Tag>>	processorTags(String processorName)	A function for creating a Micrometer Tags based on the given processorName, using the PROCESSOR_NAME_TAG key, and the MESSAGE_TYPE_TAGGER.

Methods inherited from class java.lang.Object

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

Field Details

MESSAGE_TYPE_TAG

public static final String MESSAGE_TYPE_TAG

The micrometer Tag key that represents Axon Framework's message type name.

See Also:

• Constant Field Values

PROCESSOR_NAME_TAG

public static final String PROCESSOR_NAME_TAG

The micrometer Tag key that represents the Axon Framework's EventProcessor name.

See Also:

• Constant Field Values

MESSAGE_TYPE_TAGGER

public static final Function<Message,Iterable<io.micrometer.core.instrument.Tag>> MESSAGE_TYPE_TAGGER

A function for creating the Micrometer Tag based on the message type name.

METADATA_TAGGER

public static final Function<Message,Iterable<io.micrometer.core.instrument.Tag>> METADATA_TAGGER

A function for creating the Micrometer Tags based on the message's metadata.

NO_OP

public static final Function<Message,Iterable<io.micrometer.core.instrument.Tag>> NO_OP

A function for creating no Micrometer Tags at all.

Method Details

processorNameTag

public static Function<Message,Iterable<io.micrometer.core.instrument.Tag>> processorNameTag(String processorName)

A function for creating a Micrometer Tag based on the given processorName only, using the PROCESSOR_NAME_TAG key.

Parameters:

processorName - the name of the processor to add under the PROCESSOR_NAME_TAG key as a tag

Returns:

a function for creating a Micrometer Tag based on the given processorName only, using the PROCESSOR_NAME_TAG key

processorTags

public static Function<Message,Iterable<io.micrometer.core.instrument.Tag>> processorTags(String processorName)

A function for creating a Micrometer Tags based on the given processorName, using the PROCESSOR_NAME_TAG key, and the MESSAGE_TYPE_TAGGER.

Parameters:

processorName - the name of the processor to add under the PROCESSOR_NAME_TAG key as a tag

Returns:

a function for creating a Micrometer Tags based on the given processorName, using the PROCESSOR_NAME_TAG key, and the MESSAGE_TYPE_TAGGER