Package io.micrometer.jakarta9.instrument.jms

Enum Class JmsObservationDocumentation

java.lang.Object

java.lang.Enum<JmsObservationDocumentation>

io.micrometer.jakarta9.instrument.jms.JmsObservationDocumentation

All Implemented Interfaces:

io.micrometer.observation.docs.ObservationDocumentation, Serializable, Comparable<JmsObservationDocumentation>, Constable

public enum JmsObservationDocumentation
extends Enum<JmsObservationDocumentation>
implements io.micrometer.observation.docs.ObservationDocumentation

Documented KeyValues for the observations on publication and processing of JMS messages.

Use the JmsInstrumentation class to instrument an existing JMS session for observability.

Since:

1.12.0

See Also:

• JmsInstrumentation

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	JmsObservationDocumentation.HighCardinalityKeyNames
static enum	JmsObservationDocumentation.LowCardinalityKeyNames

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
JMS_MESSAGE_PROCESS	Observation for JMS message processing.
JMS_MESSAGE_PUBLISH	Observation for JMS message publications.

Field Summary

Fields inherited from interface io.micrometer.observation.docs.ObservationDocumentation

EMPTY, EMPTY_EVENT_NAMES

Method Summary

Modifier and Type	Method	Description
static JmsObservationDocumentation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JmsObservationDocumentation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.micrometer.observation.docs.ObservationDocumentation

getContextualName, getDefaultConvention, getEvents, getHighCardinalityKeyNames, getLowCardinalityKeyNames, getName, getPrefix, observation, observation, observation, start, start, start

Enum Constant Details

JMS_MESSAGE_PUBLISH

public static final JmsObservationDocumentation JMS_MESSAGE_PUBLISH

Observation for JMS message publications. Measures the time spent sending a JMS message to a destination by a message producer.

JMS_MESSAGE_PROCESS

public static final JmsObservationDocumentation JMS_MESSAGE_PROCESS

Observation for JMS message processing. Measures the time spent processing a JMS message.

Method Details

values

public static JmsObservationDocumentation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static JmsObservationDocumentation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null