Package io.opentelemetry.instrumentation.api.incubator.semconv.db

Interface SqlClientAttributesGetter<REQUEST,RESPONSE>

All Superinterfaces:

DbClientAttributesGetter<REQUEST,RESPONSE>, DbClientCommonAttributesGetter<REQUEST,RESPONSE>, io.opentelemetry.instrumentation.api.semconv.network.NetworkAttributesGetter<REQUEST,RESPONSE>, io.opentelemetry.instrumentation.api.semconv.network.ServerAttributesGetter<REQUEST>

public interface SqlClientAttributesGetter<REQUEST,RESPONSE>
extends DbClientAttributesGetter<REQUEST,RESPONSE>

An interface for getting SQL database client attributes.

Instrumentation authors will create implementations of this interface for their specific library/framework. It will be used by the SqlClientAttributesExtractor to obtain the various SQL 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 Long	getBatchSize(REQUEST request)
default String	getDbOperationName(REQUEST request)	SqlClientAttributesExtractor will try to populate db.operation.name based on getRawQueryTexts(REQUEST), but this can be used to explicitly provide the operation name.
default String	getDbQuerySummary(REQUEST request)	SqlClientAttributesExtractor will try to populate db.query.summary based on getRawQueryTexts(REQUEST), but this can be used to explicitly provide the query summary.
default String	getDbQueryText(REQUEST request)	SqlClientAttributesExtractor will try to populate db.query.text based on getRawQueryTexts(REQUEST), but this can be used to explicitly provide the query text.
default Map<String,String>	getQueryParameters(REQUEST request)
Collection<String>	getRawQueryTexts(REQUEST request)	Get the raw SQL query texts.

Methods inherited from interface io.opentelemetry.instrumentation.api.incubator.semconv.db.DbClientAttributesGetter

getOperation, getStatement

Methods inherited from interface io.opentelemetry.instrumentation.api.incubator.semconv.db.DbClientCommonAttributesGetter

getConnectionString, getDbNamespace, getDbSystem, getResponseStatus, getUser

Methods inherited from interface io.opentelemetry.instrumentation.api.semconv.network.NetworkAttributesGetter

getNetworkLocalAddress, getNetworkLocalInetSocketAddress, getNetworkLocalPort, getNetworkPeerAddress, getNetworkPeerInetSocketAddress, getNetworkPeerPort, getNetworkProtocolName, getNetworkProtocolVersion, getNetworkTransport, getNetworkType

Methods inherited from interface io.opentelemetry.instrumentation.api.semconv.network.ServerAttributesGetter

getServerAddress, getServerPort

Method Details

getDbOperationName

@Nullable
default String getDbOperationName(REQUEST request)

SqlClientAttributesExtractor will try to populate db.operation.name based on getRawQueryTexts(REQUEST), but this can be used to explicitly provide the operation name.

Specified by:

getDbOperationName in interface DbClientAttributesGetter<REQUEST,RESPONSE>

getDbQueryText

@Nullable
default String getDbQueryText(REQUEST request)

SqlClientAttributesExtractor will try to populate db.query.text based on getRawQueryTexts(REQUEST), but this can be used to explicitly provide the query text.

Specified by:

getDbQueryText in interface DbClientAttributesGetter<REQUEST,RESPONSE>

getDbQuerySummary

@Nullable
default String getDbQuerySummary(REQUEST request)

SqlClientAttributesExtractor will try to populate db.query.summary based on getRawQueryTexts(REQUEST), but this can be used to explicitly provide the query summary.

Specified by:

getDbQuerySummary in interface DbClientAttributesGetter<REQUEST,RESPONSE>

getRawQueryTexts

Collection<String> getRawQueryTexts(REQUEST request)

Get the raw SQL query texts. The values returned by this method are later sanitized by the SqlClientAttributesExtractor before being set as span attribute.

If request is not a batch query, then this method should return a collection with a single element.

getBatchSize

@Nullable
default Long getBatchSize(REQUEST request)

getQueryParameters

default Map<String,String> getQueryParameters(REQUEST request)