Package io.opentelemetry.instrumentation.api.instrumenter.db

Class DbClientAttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

io.opentelemetry.instrumentation.api.instrumenter.db.DbClientAttributesExtractor<REQUEST,RESPONSE>

All Implemented Interfaces:

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

public final class DbClientAttributesExtractor<REQUEST,RESPONSE>
extends Object

Extractor of database client attributes.

This class delegates to a type-specific DbClientAttributesGetter for individual attribute extraction from request/response objects.

Method Summary

Modifier and Type	Method	Description
static <REQUEST, RESPONSE> DbClientAttributesExtractor<REQUEST,RESPONSE>	create(DbClientAttributesGetter<REQUEST> getter)	Creates the database client attributes extractor with default configuration.
io.opentelemetry.instrumentation.api.internal.SpanKey	internalGetSpanKey()	This method is internal and is hence not for public use.
final void	onEnd(io.opentelemetry.api.common.AttributesBuilder attributes, io.opentelemetry.context.Context context, REQUEST request, RESPONSE response, Throwable error)
void	onStart(io.opentelemetry.api.common.AttributesBuilder attributes, io.opentelemetry.context.Context parentContext, REQUEST request)

Methods inherited from class java.lang.Object

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

Method Details

create

public static <REQUEST,
RESPONSE>
DbClientAttributesExtractor<REQUEST,RESPONSE> create(DbClientAttributesGetter<REQUEST> getter)

Creates the database client attributes extractor with default configuration.

onStart

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

Specified by:

onStart in interface io.opentelemetry.instrumentation.api.instrumenter.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)

Specified by:

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

internalGetSpanKey

public io.opentelemetry.instrumentation.api.internal.SpanKey internalGetSpanKey()

This method is internal and is hence not for public use. Its API is unstable and can change at any time.

Specified by:

internalGetSpanKey in interface io.opentelemetry.instrumentation.api.internal.SpanKeyProvider