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

Class SqlClientAttributesExtractorBuilder<REQUEST,RESPONSE>

java.lang.Object
io.opentelemetry.instrumentation.api.incubator.semconv.db.SqlClientAttributesExtractorBuilder<REQUEST,RESPONSE>
public final class SqlClientAttributesExtractorBuilder<REQUEST,RESPONSE> extends Object
A builder of SqlClientAttributesExtractor.

  • Method Details

    • setTableAttribute

      @CanIgnoreReturnValue @Deprecated public SqlClientAttributesExtractorBuilder<REQUEST,RESPONSE> setTableAttribute(@Nullable io.opentelemetry.api.common.AttributeKey<String> oldSemconvTableAttribute)
      Deprecated.
      new semantic conventions always use db.collection.name
      Sets the attribute key for the old semconv table attribute. Pass null to disable emitting any table attribute under old semconv.

    • setQuerySanitizationEnabled

      @CanIgnoreReturnValue public SqlClientAttributesExtractorBuilder<REQUEST,RESPONSE> setQuerySanitizationEnabled(boolean querySanitizationEnabled)
      Sets whether the db.query.text 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.

    • setCaptureQueryParameters

      @CanIgnoreReturnValue public SqlClientAttributesExtractorBuilder<REQUEST,RESPONSE> setCaptureQueryParameters(boolean captureQueryParameters)
      Sets whether the query parameters should be captured as span attributes named db.query.parameter.<key>. Enabling this option disables the query sanitization. Disabled by default.

      WARNING: captured query parameters may contain sensitive information such as passwords, personally identifiable information or protected health info.

    • setSingleOperationAndCollection

      @CanIgnoreReturnValue public SqlClientAttributesExtractorBuilder<REQUEST,RESPONSE> setSingleOperationAndCollection(boolean singleOperationAndCollection)
      Sets whether db.operation.name and db.collection.name can be derived from db.query.text.

      Enable this only when the database system does not support query text with multiple operations or multiple collections in non-batch operations. For most instrumentations, enabling this will produce invalid semantic conventions.

    • build

      public io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<REQUEST,RESPONSE> build()
      Returns a new SqlClientAttributesExtractor with the settings of this SqlClientAttributesExtractorBuilder.