Package io.opentelemetry.instrumentation.api.instrumenter.rpc

Class RpcAttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

io.opentelemetry.instrumentation.api.instrumenter.rpc.RpcAttributesExtractor<REQUEST,RESPONSE>

All Implemented Interfaces:

AttributesExtractor<REQUEST,RESPONSE>

public abstract class RpcAttributesExtractor<REQUEST,RESPONSE>
extends Object
implements AttributesExtractor<REQUEST,RESPONSE>

Extractor of RPC attributes. Instrumentations of RPC libraries should extend this class, defining RpcAttributesExtractor with the actual request type of the instrumented library. If an attribute is not available in this library, it is appropriate to return null from the protected attribute methods, but implement as many as possible for best compliance with the OpenTelemetry specification.

Constructor Summary

Constructors

Constructor	Description
RpcAttributesExtractor()

Method Summary

Modifier and Type	Method	Description
protected abstract String	method(REQUEST request)
void	onEnd(io.opentelemetry.api.common.AttributesBuilder attributes, io.opentelemetry.context.Context context, REQUEST request, RESPONSE response, Throwable error)	Extracts attributes from the Context, the AttributesExtractor and either AttributesExtractor or error into the AttributesBuilder at the end of a request.
void	onStart(io.opentelemetry.api.common.AttributesBuilder attributes, io.opentelemetry.context.Context parentContext, REQUEST request)	Extracts attributes from the Context and the AttributesExtractor into the AttributesBuilder at the beginning of a request.
protected abstract String	service(REQUEST request)
protected abstract String	system(REQUEST request)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor

onEnd, onStart, set

Constructor Detail

RpcAttributesExtractor

public RpcAttributesExtractor()

Method Detail

onStart

public final void onStart(io.opentelemetry.api.common.AttributesBuilder attributes,
                          io.opentelemetry.context.Context parentContext,
                          REQUEST request)

Description copied from interface: AttributesExtractor

Extracts attributes from the Context and the AttributesExtractor into the AttributesBuilder at the beginning of a request.

Specified by:

onStart in interface AttributesExtractor<REQUEST,RESPONSE>

onEnd

public final void onEnd(io.opentelemetry.api.common.AttributesBuilder attributes,
                        io.opentelemetry.context.Context context,
                        REQUEST request,
                        @Nullable
                        RESPONSE response,
                        @Nullable
                        Throwable error)

Description copied from interface: AttributesExtractor

Extracts attributes from the Context, the AttributesExtractor and either AttributesExtractor or error into the AttributesBuilder at the end of a request.

Specified by:

onEnd in interface AttributesExtractor<REQUEST,RESPONSE>

system

@Nullable
protected abstract String system(REQUEST request)

service

@Nullable
protected abstract String service(REQUEST request)

method

@Nullable
protected abstract String method(REQUEST request)