Package io.opentelemetry.instrumentation.jdbc.datasource

Class JdbcTelemetryBuilder

java.lang.Object

io.opentelemetry.instrumentation.jdbc.datasource.JdbcTelemetryBuilder

public final class JdbcTelemetryBuilder
extends Object

A builder of JdbcTelemetry.

Method Summary

Modifier and Type	Method	Description
JdbcTelemetry	build()	Returns a new JdbcTelemetry with the settings of this JdbcTelemetryBuilder.
JdbcTelemetryBuilder	setCaptureQueryParameters(boolean enabled)	Configures whether parameters are captured for JDBC Statements.
JdbcTelemetryBuilder	setDataSourceInstrumenterEnabled(boolean enabled)	Configures whether spans are created for JDBC Connections.
JdbcTelemetryBuilder	setStatementInstrumenterEnabled(boolean enabled)	Configures whether spans are created for JDBC Statements.
JdbcTelemetryBuilder	setStatementSanitizationEnabled(boolean enabled)	Configures whether JDBC Statements are sanitized.
JdbcTelemetryBuilder	setTransactionInstrumenterEnabled(boolean enabled)	Configures whether spans are created for JDBC Transactions.

Methods inherited from class java.lang.Object

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

Method Details

setDataSourceInstrumenterEnabled

@CanIgnoreReturnValue
public JdbcTelemetryBuilder setDataSourceInstrumenterEnabled(boolean enabled)

Configures whether spans are created for JDBC Connections. Disabled by default.

setStatementInstrumenterEnabled

@CanIgnoreReturnValue
public JdbcTelemetryBuilder setStatementInstrumenterEnabled(boolean enabled)

Configures whether spans are created for JDBC Statements. Enabled by default.

setStatementSanitizationEnabled

@CanIgnoreReturnValue
public JdbcTelemetryBuilder setStatementSanitizationEnabled(boolean enabled)

Configures whether JDBC Statements are sanitized. Enabled by default.

setTransactionInstrumenterEnabled

@CanIgnoreReturnValue
public JdbcTelemetryBuilder setTransactionInstrumenterEnabled(boolean enabled)

Configures whether spans are created for JDBC Transactions. Disabled by default.

setCaptureQueryParameters

@CanIgnoreReturnValue
public JdbcTelemetryBuilder setCaptureQueryParameters(boolean enabled)

Configures whether parameters are captured for JDBC Statements. Enabling this option disables the statement sanitization. Disabled by default.

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

build

public JdbcTelemetry build()

Returns a new JdbcTelemetry with the settings of this JdbcTelemetryBuilder.