Package io.opentelemetry.instrumentation.api.instrumenter.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
default String	conversationId(REQUEST request)	Deprecated. Use getConversationId(Object) instead.
default String	destination(REQUEST request)	Deprecated. Use getDestination(Object) instead.
default String	destinationKind(REQUEST request)	Deprecated. Use getDestinationKind(Object) instead.
default String	getConversationId(REQUEST request)
default String	getDestination(REQUEST request)
default String	getDestinationKind(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.
default String	getMessageId(REQUEST request, RESPONSE response)
default Long	getMessagePayloadCompressedSize(REQUEST request)
default Long	getMessagePayloadSize(REQUEST request)
default String	getProtocol(REQUEST request)
default String	getProtocolVersion(REQUEST request)
default String	getSystem(REQUEST request)
default String	getUrl(REQUEST request)
default List<String>	header(REQUEST request, String name)	Deprecated. Use getMessageHeader(Object, String) instead.
default boolean	isTemporaryDestination(REQUEST request)
default String	messageId(REQUEST request, RESPONSE response)	Deprecated. Use getMessageId(Object, Object) instead.
default Long	messagePayloadCompressedSize(REQUEST request)	Deprecated. Use getMessagePayloadCompressedSize(Object) instead.
default Long	messagePayloadSize(REQUEST request)	Deprecated. Use getMessagePayloadSize(Object) instead.
default String	protocol(REQUEST request)	Deprecated. Use getProtocol(Object) instead.
default String	protocolVersion(REQUEST request)	Deprecated. Use getProtocolVersion(Object) instead.
default String	system(REQUEST request)	Deprecated. Use getSystem(Object) instead.
default boolean	temporaryDestination(REQUEST request)	Deprecated. Use isTemporaryDestination(Object) instead.
default String	url(REQUEST request)	Deprecated. Use getUrl(Object) instead.

Method Details

getSystem

@Nullable
default String getSystem(REQUEST request)

system

@Deprecated
@Nullable
default String system(REQUEST request)

Deprecated.

Use getSystem(Object) instead.

This method is deprecated and will be removed in the subsequent release.

getDestinationKind

@Nullable
default String getDestinationKind(REQUEST request)

destinationKind

@Deprecated
@Nullable
default String destinationKind(REQUEST request)

Deprecated.

Use getDestinationKind(Object) instead.

This method is deprecated and will be removed in the subsequent release.

getDestination

@Nullable
default String getDestination(REQUEST request)

destination

@Deprecated
@Nullable
default String destination(REQUEST request)

Deprecated.

Use getDestination(Object) instead.

This method is deprecated and will be removed in the subsequent release.

isTemporaryDestination

default boolean isTemporaryDestination(REQUEST request)

temporaryDestination

@Deprecated
default boolean temporaryDestination(REQUEST request)

Deprecated.

Use isTemporaryDestination(Object) instead.

This method is deprecated and will be removed in the subsequent release.

getProtocol

@Nullable
default String getProtocol(REQUEST request)

protocol

@Deprecated
@Nullable
default String protocol(REQUEST request)

Deprecated.

Use getProtocol(Object) instead.

This method is deprecated and will be removed in the subsequent release.

getProtocolVersion

@Nullable
default String getProtocolVersion(REQUEST request)

protocolVersion

@Deprecated
@Nullable
default String protocolVersion(REQUEST request)

Deprecated.

Use getProtocolVersion(Object) instead.

This method is deprecated and will be removed in the subsequent release.

getUrl

@Nullable
default String getUrl(REQUEST request)

url

@Deprecated
@Nullable
default String url(REQUEST request)

Deprecated.

Use getUrl(Object) instead.

This method is deprecated and will be removed in the subsequent release.

getConversationId

@Nullable
default String getConversationId(REQUEST request)

conversationId

@Deprecated
@Nullable
default String conversationId(REQUEST request)

Deprecated.

Use getConversationId(Object) instead.

This method is deprecated and will be removed in the subsequent release.

getMessagePayloadSize

@Nullable
default Long getMessagePayloadSize(REQUEST request)

messagePayloadSize

@Deprecated
@Nullable
default Long messagePayloadSize(REQUEST request)

Deprecated.

Use getMessagePayloadSize(Object) instead.

This method is deprecated and will be removed in the subsequent release.

getMessagePayloadCompressedSize

@Nullable
default Long getMessagePayloadCompressedSize(REQUEST request)

messagePayloadCompressedSize

@Deprecated
@Nullable
default Long messagePayloadCompressedSize(REQUEST request)

Deprecated.

Use getMessagePayloadCompressedSize(Object) instead.

This method is deprecated and will be removed in the subsequent release.

getMessageId

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

messageId

@Deprecated
@Nullable
default String messageId(REQUEST request,
 @Nullable
 RESPONSE response)

Deprecated.

Use getMessageId(Object, Object) instead.

This method is deprecated and will be removed in the subsequent release.

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.

header

@Deprecated
default List<String> header(REQUEST request,
 String name)

Deprecated.

Use getMessageHeader(Object, String) instead.

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.

This method is deprecated and will be removed in the subsequent release.