This documentation has an index for AI agents at /llms.txt. A Markdown version of this page is available at https://explorer.opentelemetry.io/java-agent/instrumentation/hikaricp-3.0.md.

HikariCP

OpenTelemetry Java agent instrumentation

This instrumentation enables database connection pool metrics for HikariCP.

  • Name: hikaricp-3.0
  • Scope: io.opentelemetry.hikaricp-3.0
  • Target versions: com.zaxxer:HikariCP:[3.0.0,)
  • Library: https://github.com/brettwooldridge/HikariCP

Telemetry

When default

Metrics

MetricInstrumentTypeUnitDescription
db.client.connections.create_timehistogramHISTOGRAMmsThe time it took to create a new connection.
db.client.connections.idle.minupdowncounterLONG_SUM{connections}The minimum number of idle open connections allowed.
db.client.connections.maxupdowncounterLONG_SUM{connections}The maximum number of open connections allowed.
db.client.connections.pending_requestsupdowncounterLONG_SUM{requests}The number of pending requests for an open connection, cumulative for the entire pool.
db.client.connections.timeoutscounterLONG_SUM{timeouts}The number of connection timeouts that have occurred trying to obtain a connection from the pool.
db.client.connections.usageupdowncounterLONG_SUM{connections}The number of connections that are currently in state described by the state attribute.
db.client.connections.use_timehistogramHISTOGRAMmsThe time between borrowing a connection and returning it to the pool.
db.client.connections.wait_timehistogramHISTOGRAMmsThe time it took to obtain an open connection from the pool.
MetricAttributes
db.client.connections.create_timepool.name (STRING)
db.client.connections.idle.minpool.name (STRING)
db.client.connections.maxpool.name (STRING)
db.client.connections.pending_requestspool.name (STRING)
db.client.connections.timeoutspool.name (STRING)
db.client.connections.usagepool.name (STRING), state (STRING)
db.client.connections.use_timepool.name (STRING)
db.client.connections.wait_timepool.name (STRING)

When otel.semconv-stability.opt-in=database

Metrics

MetricInstrumentTypeUnitDescription
db.client.connection.countupdowncounterLONG_SUM{connection}The number of connections that are currently in state described by the state attribute.
db.client.connection.create_timehistogramHISTOGRAMsThe time it took to create a new connection.
db.client.connection.idle.minupdowncounterLONG_SUM{connection}The minimum number of idle open connections allowed.
db.client.connection.limitupdowncounterLONG_SUM{connection}The maximum number of open connections allowed.
db.client.connection.pending_requestsupdowncounterLONG_SUM{request}The number of current pending requests for an open connection.
db.client.connection.timeoutscounterLONG_SUM{timeout}The number of connection timeouts that have occurred trying to obtain a connection from the pool.
db.client.connection.use_timehistogramHISTOGRAMsThe time between borrowing a connection and returning it to the pool.
db.client.connection.wait_timehistogramHISTOGRAMsThe time it took to obtain an open connection from the pool.
MetricAttributes
db.client.connection.countdb.client.connection.pool.name (STRING), db.client.connection.state (STRING)
db.client.connection.create_timedb.client.connection.pool.name (STRING)
db.client.connection.idle.mindb.client.connection.pool.name (STRING)
db.client.connection.limitdb.client.connection.pool.name (STRING)
db.client.connection.pending_requestsdb.client.connection.pool.name (STRING)
db.client.connection.timeoutsdb.client.connection.pool.name (STRING)
db.client.connection.use_timedb.client.connection.pool.name (STRING)
db.client.connection.wait_timedb.client.connection.pool.name (STRING)

Data

  • JSON (latest): /data/javaagent/instrumentations/hikaricp-3.0/latest.json
  • JSON (pinned): /data/javaagent/instrumentations/hikaricp-3.0/hikaricp-3.0-bf7710fb8e8f.json
  • Explore: /java-agent/instrumentation/hikaricp-3.0