OpenTracing Instrumentation for JDBC
Clone or download

README.md

Build Status Coverage Status Released Version

OpenTracing JDBC Instrumentation

OpenTracing instrumentation for JDBC.

Installation

pom.xml

<dependency>
    <groupId>io.opentracing.contrib</groupId>
    <artifactId>opentracing-jdbc</artifactId>
    <version>VERSION</version>
</dependency>

Usage

  1. Add tracing to jdbc url. E.g. jdbc:tracing:h2:mem:test
    To trace calls only if there is an active Span use property traceWithActiveSpanOnly=true.
    E.g. jdbc:tracing:h2:mem:test?traceWithActiveSpanOnly=true To ignore specific queries (such as health checks) use the property ignoreForTracing="SELECT 1". Double quotes can be escaped with \ (i.e.) SELECT * FROM \"TEST\" and the property can be repeated for multiple statements.

  2. Set driver class to io.opentracing.contrib.jdbc.TracingDriver

  3. Instantiate tracer and register it with GlobalTracer

// Instantiate tracer
Tracer tracer = ...

// Register tracer with GlobalTracer
GlobalTracer.register(tracer);

Hibernate

<hibernate-configuration>
    <session-factory>
        <property name="hibernate.connection.driver_class">io.opentracing.contrib.jdbc.TracingDriver</property>
        <property name="hibernate.connection.url">jdbc:tracing:mysql://localhost:3306/test</property>
        ...
    </session-factory>
    ...
</hibernate-configuration>

JPA

<persistence-unit name="jpa">
    <properties>
        <property name="javax.persistence.jdbc.driver" value="io.opentracing.contrib.jdbc.TracingDriver"/>
        <property name="javax.persistence.jdbc.url" value="jdbc:tracing:mysql://localhost:3306/test"/>
        ...
    </properties>
</persistence-unit>

Spring

For dbcp2:

<bean id="dataSource" destroy-method="close" class="org.apache.commons.dbcp2.BasicDataSource">
    <property name="driverClassName" value="io.opentracing.contrib.jdbc.TracingDriver"/>
    <property name="url" value="jdbc:tracing:mysql://localhost:3306/test"/>
    ...
</bean> 

Troubleshooting

In case of Unable to find a driver error the database driver should be registered before configuring the datasource.
E.g. Class.forName("com.mysql.jdbc.Driver");

License

Apache 2.0 License.