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

Interface DbClientAttributesGetter<REQUEST>

All Superinterfaces:

DbClientCommonAttributesGetter<REQUEST>

public interface DbClientAttributesGetter<REQUEST>
extends DbClientCommonAttributesGetter<REQUEST>

An interface for getting database client attributes.

Instrumentation authors will create implementations of this interface for their specific library/framework. It will be used by the DbClientAttributesExtractor to obtain the various database client attributes in a type-generic way.

If an attribute is not available in this library, it is appropriate to return null from the attribute methods, but implement as many as possible for best compliance with the OpenTelemetry specification.

Method Summary

Modifier and Type	Method	Description
default String	getOperation(REQUEST request)
default String	getStatement(REQUEST request)
default String	operation(REQUEST request)	Deprecated. Use getOperation(Object) instead.
default String	statement(REQUEST request)	Deprecated. Use getStatement(Object) instead.

Methods inherited from interface io.opentelemetry.instrumentation.api.instrumenter.db.DbClientCommonAttributesGetter

connectionString, getConnectionString, getName, getSystem, getUser, name, system, user

Method Details

getStatement

@Nullable
default String getStatement(REQUEST request)

statement

@Deprecated
@Nullable
default String statement(REQUEST request)

Deprecated.

Use getStatement(Object) instead.

This method is deprecated and will be removed in the subsequent release.

getOperation

@Nullable
default String getOperation(REQUEST request)

operation

@Deprecated
@Nullable
default String operation(REQUEST request)

Deprecated.

Use getOperation(Object) instead.

This method is deprecated and will be removed in the subsequent release.