Package io.opentelemetry.instrumentation.api.incubator.semconv.messaging

Interface MessagingAttributesGetter<REQUEST,RESPONSE>

public interface MessagingAttributesGetter<REQUEST,RESPONSE>

An interface for getting messaging attributes.

Instrumentation authors will create implementations of this interface for their specific library/framework. It will be used by the MessagingAttributesExtractor to obtain the various messaging attributes in a type-generic way.

Method Summary

Modifier and Type	Method	Description
Long	getBatchMessageCount(REQUEST request, RESPONSE response)
String	getClientId(REQUEST request)
String	getConversationId(REQUEST request)
String	getDestination(REQUEST request)
String	getDestinationTemplate(REQUEST request)
Long	getMessageBodySize(REQUEST request)
Long	getMessageEnvelopeSize(REQUEST request)
default List<String>	getMessageHeader(REQUEST request, String name)	Extracts all values of header named name from the request, or an empty list if there were none.
String	getMessageId(REQUEST request, RESPONSE response)
default Long	getMessagePayloadCompressedSize(REQUEST request)	Deprecated.
default Long	getMessagePayloadSize(REQUEST request)	Deprecated.
String	getSystem(REQUEST request)
boolean	isAnonymousDestination(REQUEST request)
boolean	isTemporaryDestination(REQUEST request)

Method Details

getSystem

@Nullable
String getSystem(REQUEST request)

getDestination

@Nullable
String getDestination(REQUEST request)

getDestinationTemplate

@Nullable
String getDestinationTemplate(REQUEST request)

isTemporaryDestination

boolean isTemporaryDestination(REQUEST request)

isAnonymousDestination

boolean isAnonymousDestination(REQUEST request)

getConversationId

@Nullable
String getConversationId(REQUEST request)

getMessagePayloadSize

@Nullable
@Deprecated
default Long getMessagePayloadSize(REQUEST request)

Deprecated.

getMessagePayloadCompressedSize

@Nullable
@Deprecated
default Long getMessagePayloadCompressedSize(REQUEST request)

Deprecated.

getMessageBodySize

@Nullable
Long getMessageBodySize(REQUEST request)

getMessageEnvelopeSize

@Nullable
Long getMessageEnvelopeSize(REQUEST request)

getMessageId

@Nullable
String getMessageId(REQUEST request,
 @Nullable
 RESPONSE response)

getClientId

@Nullable
String getClientId(REQUEST request)

getBatchMessageCount

@Nullable
Long getBatchMessageCount(REQUEST request,
 @Nullable
 RESPONSE response)

getMessageHeader

default List<String> getMessageHeader(REQUEST request,
 String name)

Extracts all values of header named name from the request, or an empty list if there were none.

Implementations of this method must not return a null value; an empty list should be returned instead.