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
String	conversationId(REQUEST request)
String	destination(REQUEST request)
String	destinationKind(REQUEST request)
default List<String>	header(REQUEST request, String name)	Extracts all values of header named name from the request, or an empty list if there were none.
String	messageId(REQUEST request, RESPONSE response)
Long	messagePayloadCompressedSize(REQUEST request)
Long	messagePayloadSize(REQUEST request)
String	protocol(REQUEST request)
String	protocolVersion(REQUEST request)
String	system(REQUEST request)
boolean	temporaryDestination(REQUEST request)
String	url(REQUEST request)

Method Details

system

@Nullable
String system(REQUEST request)

destinationKind

@Nullable
String destinationKind(REQUEST request)

destination

@Nullable
String destination(REQUEST request)

temporaryDestination

boolean temporaryDestination(REQUEST request)

protocol

@Nullable
String protocol(REQUEST request)

protocolVersion

@Nullable
String protocolVersion(REQUEST request)

url

@Nullable
String url(REQUEST request)

conversationId

@Nullable
String conversationId(REQUEST request)

messagePayloadSize

@Nullable
Long messagePayloadSize(REQUEST request)

messagePayloadCompressedSize

@Nullable
Long messagePayloadCompressedSize(REQUEST request)

messageId

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

header

default List<String> header(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.