Package brave.jakarta.jms

Class JmsTracing

java.lang.Object

brave.jakarta.jms.JmsTracing

public final class JmsTracing
extends Object

Use this class to decorate your JMS consumer / producer and enable Tracing.

Since:

5.12

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	JmsTracing.Builder

Method Summary

Modifier and Type	Method	Description
jakarta.jms.Connection	connection(jakarta.jms.Connection connection)
jakarta.jms.ConnectionFactory	connectionFactory(jakarta.jms.ConnectionFactory connectionFactory)
static JmsTracing	create(MessagingTracing messagingTracing)
static JmsTracing	create(brave.Tracing tracing)
jakarta.jms.MessageListener	messageListener(jakarta.jms.MessageListener messageListener, boolean addConsumerSpan)	Returns a message listener that optionally starts a consumer span for the message received before wrapping the listener in a separate span.
static JmsTracing.Builder	newBuilder(MessagingTracing messagingTracing)
static JmsTracing.Builder	newBuilder(brave.Tracing tracing)
brave.Span	nextSpan(jakarta.jms.Message message)	Use this to create a span for processing the given message.
jakarta.jms.QueueConnection	queueConnection(jakarta.jms.QueueConnection connection)
jakarta.jms.TopicConnection	topicConnection(jakarta.jms.TopicConnection connection)
jakarta.jms.XAConnection	xaConnection(jakarta.jms.XAConnection xaConnection)
jakarta.jms.XAConnectionFactory	xaConnectionFactory(jakarta.jms.XAConnectionFactory xaConnectionFactory)
jakarta.jms.XAQueueConnection	xaQueueConnection(jakarta.jms.XAQueueConnection connection)
jakarta.jms.XATopicConnection	xaTopicConnection(jakarta.jms.XATopicConnection connection)

Methods inherited from class java.lang.Object

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

Method Detail

create

public static JmsTracing create(brave.Tracing tracing)

create

public static JmsTracing create(MessagingTracing messagingTracing)

newBuilder

public static JmsTracing.Builder newBuilder(brave.Tracing tracing)

newBuilder

public static JmsTracing.Builder newBuilder(MessagingTracing messagingTracing)

connection

public jakarta.jms.Connection connection(jakarta.jms.Connection connection)

queueConnection

public jakarta.jms.QueueConnection queueConnection(jakarta.jms.QueueConnection connection)

topicConnection

public jakarta.jms.TopicConnection topicConnection(jakarta.jms.TopicConnection connection)

xaConnection

public jakarta.jms.XAConnection xaConnection(jakarta.jms.XAConnection xaConnection)

xaQueueConnection

public jakarta.jms.XAQueueConnection xaQueueConnection(jakarta.jms.XAQueueConnection connection)

xaTopicConnection

public jakarta.jms.XATopicConnection xaTopicConnection(jakarta.jms.XATopicConnection connection)

connectionFactory

public jakarta.jms.ConnectionFactory connectionFactory(jakarta.jms.ConnectionFactory connectionFactory)

xaConnectionFactory

public jakarta.jms.XAConnectionFactory xaConnectionFactory(jakarta.jms.XAConnectionFactory xaConnectionFactory)

messageListener

public jakarta.jms.MessageListener messageListener(jakarta.jms.MessageListener messageListener,
                                                   boolean addConsumerSpan)

Returns a message listener that optionally starts a consumer span for the message received before wrapping the listener in a separate span.

Parameters:

messageListener - listener to wrap

addConsumerSpan - set to true when the underlying message receipt is not traced (ex. JCA)

nextSpan

public brave.Span nextSpan(jakarta.jms.Message message)

Use this to create a span for processing the given message. Note: the result has no name and is not started.

In general, prefer MessageListener for processing messages, as it is more efficient and less lossy with regards to context data.

This creates a child from identifiers extracted from the message properties, or a new span if one couldn't be extracted.