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

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

Nested and Inner Type Summary

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

Field Summary

Modifier and Type	Field and Description
public static final JmsObservationDocumentation	JMS_MESSAGE_PROCESS Observation for JMS message processing.
public static final JmsObservationDocumentation	JMS_MESSAGE_PUBLISH Observation for JMS message publications.

Access	Constructor and Description
private	JmsObservationDocumentation()

Method Summary

Modifier and Type	Method and Description
public static JmsObservationDocumentation	valueOf(String name)
public static JmsObservationDocumentation[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

JMS_MESSAGE_PROCESS	back to summary
public static final JmsObservationDocumentation JMS_MESSAGE_PROCESS Observation for JMS message processing. Measures the time spent `processing a JMS message`.

JMS_MESSAGE_PUBLISH	back to summary
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`.

JmsObservationDocumentation	back to summary
private JmsObservationDocumentation()

Method Detail

valueOf	back to summary
public static JmsObservationDocumentation valueOf(String name)

values	back to summary
public static JmsObservationDocumentation[] values()

io.micrometer.jakarta9.instrument.jms back to summary

public sealed Enum JmsObservationDocumentation.HighCardinalityKeyNames

Class Inheritance

extends Enum<JmsObservationDocumentation.HighCardinalityKeyNames>
implements KeyName

java.lang.Object
java.lang.Enum
io.micrometer.jakarta9.instrument.jms.JmsObservationDocumentation.HighCardinalityKeyNames

All Implemented Interfaces

io.micrometer.common.docs.KeyName

Field Summary

Modifier and Type	Field and Description
public static final JmsObservationDocumentation.HighCardinalityKeyNames	CONVERSATION_ID The correlation ID of the JMS message.
public static final JmsObservationDocumentation.HighCardinalityKeyNames	DESTINATION_NAME The name of destination the current message was sent to.
public static final JmsObservationDocumentation.HighCardinalityKeyNames	MESSAGE_ID Value used by the messaging system as an identifier for the message.

Constructor Summary

Access	Constructor and Description
private	HighCardinalityKeyNames()

Method Summary

Modifier and Type	Method and Description
public static JmsObservationDocumentation.HighCardinalityKeyNames	valueOf(String name)
public static JmsObservationDocumentation.HighCardinalityKeyNames[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

CONVERSATION_ID	back to summary
public static final JmsObservationDocumentation.HighCardinalityKeyNames CONVERSATION_ID The correlation ID of the JMS message.

DESTINATION_NAME	back to summary
public static final JmsObservationDocumentation.HighCardinalityKeyNames DESTINATION_NAME The name of destination the current message was sent to.

MESSAGE_ID	back to summary
public static final JmsObservationDocumentation.HighCardinalityKeyNames MESSAGE_ID Value used by the messaging system as an identifier for the message.

Constructor Detail

HighCardinalityKeyNames	back to summary
private HighCardinalityKeyNames()

Method Detail

valueOf	back to summary
public static JmsObservationDocumentation.HighCardinalityKeyNames valueOf(String name)

values	back to summary
public static JmsObservationDocumentation.HighCardinalityKeyNames[] values()

io.micrometer.jakarta9.instrument.jms back to summary

public sealed Enum JmsObservationDocumentation.LowCardinalityKeyNames

Class Inheritance

extends Enum<JmsObservationDocumentation.LowCardinalityKeyNames>
implements KeyName

java.lang.Object
java.lang.Enum
io.micrometer.jakarta9.instrument.jms.JmsObservationDocumentation.LowCardinalityKeyNames

All Implemented Interfaces

io.micrometer.common.docs.KeyName

Field Summary

Modifier and Type	Field and Description
public static final JmsObservationDocumentation.LowCardinalityKeyNames	DESTINATION_TEMPORARY Whether the destination (queue or topic) is temporary.
public static final JmsObservationDocumentation.LowCardinalityKeyNames	EXCEPTION Name of the exception thrown during the operation, or none if no exception happened.
public static final JmsObservationDocumentation.LowCardinalityKeyNames	OPERATION The name of the JMS operation being performed.

Constructor Summary

Access	Constructor and Description
private	LowCardinalityKeyNames()

Method Summary

Modifier and Type	Method and Description
public static JmsObservationDocumentation.LowCardinalityKeyNames	valueOf(String name)
public static JmsObservationDocumentation.LowCardinalityKeyNames[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DESTINATION_TEMPORARY	back to summary
public static final JmsObservationDocumentation.LowCardinalityKeyNames DESTINATION_TEMPORARY Whether the destination (queue or topic) is temporary.

EXCEPTION	back to summary
public static final JmsObservationDocumentation.LowCardinalityKeyNames EXCEPTION Name of the exception thrown during the operation, or none if no exception happened.

OPERATION back to summary

OPERATION	back to summary
public static final JmsObservationDocumentation.LowCardinalityKeyNames OPERATION The name of the JMS operation being performed. Can be one of: "publish" when `sending a JMS message to a destination` "process" when a `listener processes a received message`

public static final JmsObservationDocumentation.LowCardinalityKeyNames OPERATION

The name of the JMS operation being performed. Can be one of:

"publish" when sending a JMS message to a destination
"process" when a listener processes a received message

Constructor Detail

LowCardinalityKeyNames	back to summary
private LowCardinalityKeyNames()

Method Detail

valueOf	back to summary
public static JmsObservationDocumentation.LowCardinalityKeyNames valueOf(String name)

values	back to summary
public static JmsObservationDocumentation.LowCardinalityKeyNames[] values()