HikariCP

Supported OS Linux Windows Mac OS

Integration version1.2.0

Overview

HikariCP is a lightweight and fast JDBC connection pooling framework. This check monitors HikariCP through the Datadog Agent.

Setup

Installation

To install the HikariCP check on your host:

  1. Install the developer toolkit on any machine.

  2. Run ddev release build hikaricp to build the package.

  3. Download the Datadog Agent.

  4. Upload the build artifact to any host with an Agent and run datadog-agent integration install -w path/to/hikaricp/dist/<ARTIFACT_NAME>.whl.

Configuration

  1. Edit the hikaricp/conf.yaml file, in the conf.d/ folder at the root of your Agent’s configuration directory to start collecting your HikariCP performance data. See the sample hikaricp/conf.yaml for all available configuration options.

  2. Restart the Agent.

Validation

Run the Agent’s status subcommand and look for hikaricp under the Checks section.

Data Collected

Metrics

hikaricp.connections
(gauge)		Number of connections
hikaricp.connections.timeout.count
(count)		Total number of timeout connections
hikaricp.connections.active
(gauge)		Number of active connections
hikaricp.connections.idle
(gauge)		Number of idle connections
hikaricp.connections.max
(gauge)		Max number of connections
Shown as connection
hikaricp.connections.min
(gauge)		Min number of connections
Shown as connection
hikaricp.connections.pending
(gauge)		Number of pending connections
hikaricp.connections.acquire.seconds.count
(count)		Count of acquire connection time
Shown as second
hikaricp.connections.acquire.seconds.max
(gauge)		Max of acquire connection time
Shown as second
hikaricp.connections.acquire.seconds.sum
(count)		Sum of acquire connection time
Shown as second
hikaricp.connections.creation.seconds.count
(count)		Count of creation connection time
Shown as second
hikaricp.connections.creation.seconds.max
(gauge)		Max of creation connection time
Shown as second
hikaricp.connections.creation.seconds.sum
(count)		Sum of creation connection time
Shown as second
hikaricp.connections.usage.seconds.count
(count)		Count of usage connection time
Shown as second
hikaricp.connections.usage.seconds.max
(gauge)		Max of usage connection time
Shown as second
hikaricp.connections.usage.seconds.sum
(count)		Sum of usage connection time
Shown as second
hikaricp.threads.pending
(gauge)		Number of pending threads
Shown as thread
hikaricp.connections.acquired.nanos.count
(count)		Count of acquired connection time
Shown as nanosecond
hikaricp.connections.acquired.nanos.sum
(count)		Sum of acquired connection time
Shown as nanosecond
hikaricp.connections.acquired.nanos.quantile
(gauge)		Quantile of acquired connection time
Shown as nanosecond
hikaricp.connections.creation.millis.count
(count)		Count of connection creation time
Shown as millisecond
hikaricp.connections.creation.millis.sum
(count)		Sum of connection creation time
Shown as millisecond
hikaricp.connections.creation.millis.quantile
(gauge)		Quantile of connection creation time
Shown as millisecond
hikaricp.connections.usage.millis.count
(count)		Count of connection usage time
Shown as millisecond
hikaricp.connections.usage.millis.sum
(count)		Sum of connection usage time
Shown as millisecond
hikaricp.connections.usage.millis.quantile
(gauge)		Quantile of connection usage time
Shown as millisecond

Events

HikariCP does not include any events.

Troubleshooting

Need help? Contact Datadog support.