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

Class SqlClientAttributesExtractorBuilder<REQUEST,RESPONSE>

java.lang.Object

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

public final class SqlClientAttributesExtractorBuilder<REQUEST,RESPONSE>
extends Object

A builder of SqlClientAttributesExtractor.

Method Summary

Modifier and Type	Method	Description
io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<REQUEST,RESPONSE>	build()	Returns a new SqlClientAttributesExtractor with the settings of this SqlClientAttributesExtractorBuilder.
SqlClientAttributesExtractorBuilder<REQUEST,RESPONSE>	setStatementSanitizationEnabled(boolean statementSanitizationEnabled)	Sets whether the db.statement attribute extracted by the constructed SqlClientAttributesExtractor should be sanitized.
SqlClientAttributesExtractorBuilder<REQUEST,RESPONSE>	setTableAttribute(io.opentelemetry.api.common.AttributeKey<String> dbTableAttribute)	Configures the extractor to set the table value extracted by the SqlClientAttributesExtractor under the dbTableAttribute key.

Methods inherited from class java.lang.Object

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

Method Details

setTableAttribute

@CanIgnoreReturnValue
public SqlClientAttributesExtractorBuilder<REQUEST,RESPONSE> setTableAttribute(io.opentelemetry.api.common.AttributeKey<String> dbTableAttribute)

Configures the extractor to set the table value extracted by the SqlClientAttributesExtractor under the dbTableAttribute key. By default, the db.sql.table attribute is used.

Parameters:

dbTableAttribute - The AttributeKey under which the table extracted by the SqlClientAttributesExtractor will be stored.

setStatementSanitizationEnabled

@CanIgnoreReturnValue
public SqlClientAttributesExtractorBuilder<REQUEST,RESPONSE> setStatementSanitizationEnabled(boolean statementSanitizationEnabled)

Sets whether the db.statement attribute extracted by the constructed SqlClientAttributesExtractor should be sanitized. If set to true, all parameters that can potentially contain sensitive information will be masked. Enabled by default.

build

public io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<REQUEST,RESPONSE> build()

Returns a new SqlClientAttributesExtractor with the settings of this SqlClientAttributesExtractorBuilder.