Class JdbiOpenTelemetryPlugin

java.lang.Object

org.jdbi.v3.core.spi.JdbiPlugin.Singleton

org.jdbi.v3.opentelemetry.JdbiOpenTelemetryPlugin

All Implemented Interfaces:

JdbiPlugin

public class JdbiOpenTelemetryPlugin
extends JdbiPlugin.Singleton

Enable OpenTelemetry support. Emits a trace span for every statement executed by Jdbi.

Nested Class Summary

Nested classes/interfaces inherited from interface JdbiPlugin

JdbiPlugin.Singleton

Modifier and Type	Interface	Description
static class	JdbiPlugin.Singleton	Abstract base class for single-install JdbiPlugins.

Field Summary

Fields

Modifier and Type	Field	Description
static final io.opentelemetry.api.common.AttributeKey<String>	BINDING
static final io.opentelemetry.api.common.AttributeKey<Long>	NUM_ROWS
static final io.opentelemetry.api.common.AttributeKey<String>	SQL

Constructor Summary

Constructors

Constructor	Description
JdbiOpenTelemetryPlugin()	Enable OpenTelemetry support with the global OpenTelemetry instance.
JdbiOpenTelemetryPlugin(io.opentelemetry.api.OpenTelemetry telemetry)	Enable OpenTelemetry support with the supplied OpenTelemetry instance.

Method Summary

Modifier and Type	Method	Description
void	customizeJdbi(Jdbi jdbi)	Configure customizations global to any object managed by this Jdbi.

Methods inherited from class JdbiPlugin.Singleton

equals, hashCode

Modifier and Type	Method	Description
boolean	equals(Object obj)
int	hashCode()

Methods inherited from class Object

getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface JdbiPlugin

customizeConnection, customizeHandle

Modifier and Type	Method	Description
default Connection	customizeConnection(Connection conn)	Configure customizations for a newly acquired Connection.
default Handle	customizeHandle(Handle handle)	Configure customizations for a new Handle instance.

Field Details

SQL

public static final io.opentelemetry.api.common.AttributeKey<String> SQL

BINDING

public static final io.opentelemetry.api.common.AttributeKey<String> BINDING

NUM_ROWS

public static final io.opentelemetry.api.common.AttributeKey<Long> NUM_ROWS

Constructor Details

JdbiOpenTelemetryPlugin

public JdbiOpenTelemetryPlugin()

Enable OpenTelemetry support with the global OpenTelemetry instance.

JdbiOpenTelemetryPlugin

public JdbiOpenTelemetryPlugin(io.opentelemetry.api.OpenTelemetry telemetry)

Enable OpenTelemetry support with the supplied OpenTelemetry instance.

Parameters:

telemetry - the OpenTelemetry to emit spans to

Method Details

customizeJdbi

public void customizeJdbi(Jdbi jdbi)
                   throws SQLException

Description copied from interface: JdbiPlugin

Configure customizations global to any object managed by this Jdbi. This method is invoked immediately when the plugin is installed.

Parameters:

jdbi - the jdbi to customize

Throws:

SQLException - something went wrong with the database