History

Mateusz Rzeszutek 4fd52c5a7c Encode version in library instrumentations' package names (#7764 ) Another part of #932 In this PR I changed all the library instrumentation packages -- these are breaking changes, so I figured the earlier we do this the less painful it'll be to the users. I know that at least some of them are actively used, so we'll need to spell this out in the release notes. --------- Co-authored-by: Trask Stalnaker <trask.stalnaker@gmail.com>		2023-02-14 23:25:59 +00:00
..
src	Encode version in library instrumentations' package names (#7764 )	2023-02-14 23:25:59 +00:00
README.md	Introduce markdown lint check (#7175 )	2022-11-16 20:48:42 -08:00
build.gradle.kts	Implement HikariCP library instrumentation (#6023 )	2022-05-13 10:22:35 -07:00

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());
}