opentelemetry-java-instrumentation/instrumentation/hikaricp-3.0/library/README.md

Library Instrumentation for HikariCP version 3.0 and higher

Provides OpenTelemetry instrumentation for HikariCP.

Quickstart

Add these dependencies to your project

Replace OPENTELEMETRY_VERSION with the latest release.

For Maven, add to your pom.xml dependencies:

<dependencies>
  <dependency>
    <groupId>io.opentelemetry.instrumentation</groupId>
    <artifactId>opentelemetry-hikaricp-3.0</artifactId>
    <version>OPENTELEMETRY_VERSION</version>
  </dependency>
</dependencies>

For Gradle, add to your dependencies:

implementation("io.opentelemetry.instrumentation:opentelemetry-hikaricp-3.0:OPENTELEMETRY_VERSION")

Usage

The instrumentation library provides a MetricsTrackerFactory implementation that can be added to an instance of the HikariConfig (or HikariDataSource) to provide OpenTelemetry-based metrics.

void configure(OpenTelemetry openTelemetry, HikariConfig connectionPoolConfig) {
  HikariTelemetry telemetry = HikariTelemetry.create(openTelemetry);
  connectionPoolConfig.setMetricsTrackerFactory(telemetry.createMetricsTrackerFactory());
}