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

Class RpcAttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<REQUEST,RESPONSE>

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

public abstract class RpcAttributesExtractor<REQUEST,RESPONSE>
extends 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 @Nullable String	method(REQUEST request)
protected void	onEnd(io.opentelemetry.api.common.AttributesBuilder attributes, REQUEST request, RESPONSE response)	Extracts attributes from the AttributesExtractor and AttributesExtractor into the AttributesBuilder at the end of a request.
protected void	onStart(io.opentelemetry.api.common.AttributesBuilder attributes, REQUEST request)	Extracts attributes from the AttributesExtractor into the AttributesBuilder at the beginning of a request.
protected abstract @Nullable String	service(REQUEST request)
protected abstract @Nullable String	system(REQUEST request)

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

set

Methods inherited from class java.lang.Object

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

Constructor Detail

RpcAttributesExtractor

public RpcAttributesExtractor()

Method Detail

onStart

protected final void onStart(io.opentelemetry.api.common.AttributesBuilder attributes,
                             REQUEST request)

Description copied from class: AttributesExtractor

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

Specified by:

onStart in class AttributesExtractor<REQUEST,RESPONSE>

onEnd

protected final void onEnd(io.opentelemetry.api.common.AttributesBuilder attributes,
                           REQUEST request,
                           RESPONSE response)

Description copied from class: AttributesExtractor

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

Specified by:

onEnd in class AttributesExtractor<REQUEST,RESPONSE>

system

protected abstract @Nullable String system(REQUEST request)

service

protected abstract @Nullable String service(REQUEST request)

method

protected abstract @Nullable String method(REQUEST request)