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

Class DbAttributesExtractor<REQUEST,RESPONSE>

java.lang.Object

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

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

Direct Known Subclasses:

SqlAttributesExtractor

public abstract class DbAttributesExtractor<REQUEST,RESPONSE>
extends AttributesExtractor<REQUEST,RESPONSE>

Extractor of database attributes. Instrumentations of database libraries should extend this class, defining DbAttributesExtractor 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
DbAttributesExtractor()

Method Summary

Modifier and Type	Method	Description
protected abstract @Nullable String	connectionString(REQUEST request)
protected abstract @Nullable String	name(REQUEST request)
protected void	onEnd(io.opentelemetry.api.common.AttributesBuilder attributes, REQUEST request, @Nullable 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	operation(REQUEST request)
protected abstract @Nullable String	statement(REQUEST request)
protected abstract @Nullable String	system(REQUEST request)
protected abstract @Nullable String	user(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

DbAttributesExtractor

public DbAttributesExtractor()

Method Detail

onStart

protected 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,
                           @Nullable 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)

user

protected abstract @Nullable String user(REQUEST request)

name

protected abstract @Nullable String name(REQUEST request)

connectionString

protected abstract @Nullable String connectionString(REQUEST request)

statement

protected abstract @Nullable String statement(REQUEST request)

operation

protected abstract @Nullable String operation(REQUEST request)