opentelemetry-java-instrumentation/instrumentation/vibur-dbcp-11.0/library/README.md

Manual Instrumentation for Vibur DBCP

Provides OpenTelemetry instrumentation for Vibur DBCP.

Quickstart

Add these dependencies to your project:

Replace OPENTELEMETRY_VERSION with the latest stable release. Minimum version: 1.15.0

For Maven, add to your pom.xml dependencies:

<dependencies>
  <dependency>
    <groupId>io.opentelemetry.instrumentation</groupId>
    <artifactId>opentelemetry-vibur-dbcp-11.0</artifactId>
    <version>OPENTELEMETRY_VERSION</version>
  </dependency>
</dependencies>

For Gradle, add to your dependencies:

implementation("io.opentelemetry.instrumentation:opentelemetry-vibur-dbcp-11.0:OPENTELEMETRY_VERSION")

Usage

The instrumentation library allows registering ViburDBCPDataSource instances for collecting OpenTelemetry-based metrics.

ViburTelemetry viburTelemetry;

void configure(OpenTelemetry openTelemetry, ViburDBCPDataSource viburDataSource) {
  viburTelemetry = ViburTelemetry.create(openTelemetry);
  viburTelemetry.registerMetrics(viburDataSource);
}

void destroy(ViburDBCPDataSource viburDataSource) {
  viburTelemetry.unregisterMetrics(viburDataSource);
}