Hikari CP Instrumentation #

As part of the JDBC instrumentation, Kamon can automatically gather performance metrics out of Hikari connection pools and use the pool information when creating Spans from Statements execution.

Metrics #

All Hikari connection pools will get the following metrics:

jdbc.pool.connections.open range sampler

Tracks the number of open connections in a pool.

Tags included by default:

jdbc.pool.vendor: Name of the connection pool vendor.
jdbc.pool.name: Name of the connection pool for which the metric is being tracked.
db.vendor: Name of the JDBC driver vendor.

jdbc.pool.connections.borrowed range sampler

Tracks the number of borrowed connections in a pool.

Tags included by default:

jdbc.pool.vendor: Name of the connection pool vendor.
jdbc.pool.name: Name of the connection pool for which the metric is being tracked.
db.vendor: Name of the JDBC driver vendor.

jdbc.pool.borrow-time timer

Tracks the time it takes for the connection pool to lease a connection.

Tags included by default:

jdbc.pool.vendor: Name of the connection pool vendor.
jdbc.pool.name: Name of the connection pool for which the metric is being tracked.
db.vendor: Name of the JDBC driver vendor.

jdbc.pool.borrow-timeouts counter

Counts how many times the connection pool timed out while trying to lease a connection.

Tags included by default:

jdbc.pool.vendor: Name of the connection pool vendor.
jdbc.pool.name: Name of the connection pool for which the metric is being tracked.
db.vendor: Name of the JDBC driver vendor.

Manual Installation #

In case you are not using the Kamon Bundle, add the dependency below to your build:


libraryDependencies += "io.kamon" %% "kamon-jdbc" % "2.5.9"


    <dependency>
      <groupId>io.kamon</groupId>
      <artifactId>kamon-jdbc_2.13</artifactId>
      <version>2.5.9</version>
    </dependency>


implementation 'io.kamon:kamon-jdbc_2.13:2.5.9'

You must start your application with the instrumentation agent for this module to work properly.

On this article