Package com.zaxxer.hikari.metrics.prometheus

Class PrometheusMetricsTrackerFactory

java.lang.Object

com.zaxxer.hikari.metrics.prometheus.PrometheusMetricsTrackerFactory

All Implemented Interfaces:

MetricsTrackerFactory

public class PrometheusMetricsTrackerFactory
extends Object
implements MetricsTrackerFactory

 HikariConfig config = new HikariConfig();
 config.setMetricsTrackerFactory(new PrometheusMetricsTrackerFactory());
 

or

 config.setMetricsTrackerFactory(new PrometheusMetricsTrackerFactory(new CollectorRegistry()));
 

Note: the internal Summary requires heavy locks. Consider using PrometheusHistogramMetricsTrackerFactory if performance plays a role and you don't need the summary per se.

Constructor Summary

Constructors

Constructor	Description
PrometheusMetricsTrackerFactory()	Default Constructor.
PrometheusMetricsTrackerFactory(io.prometheus.client.CollectorRegistry collectorRegistry)	Constructor that allows to pass in a CollectorRegistry to which the Hikari metrics are registered.

Method Summary

Modifier and Type	Method	Description
IMetricsTracker	create(String poolName, PoolStats poolStats)	Create an instance of an IMetricsTracker.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PrometheusMetricsTrackerFactory

public PrometheusMetricsTrackerFactory()

Default Constructor. The Hikari metrics are registered to the default collector registry (CollectorRegistry.defaultRegistry).

PrometheusMetricsTrackerFactory

public PrometheusMetricsTrackerFactory(io.prometheus.client.CollectorRegistry collectorRegistry)

Constructor that allows to pass in a CollectorRegistry to which the Hikari metrics are registered.

Parameters:

collectorRegistry - the collector registry to register the metrics to

Method Detail

create

public IMetricsTracker create(String poolName,
                              PoolStats poolStats)

Description copied from interface: MetricsTrackerFactory

Create an instance of an IMetricsTracker.

Specified by:

create in interface MetricsTrackerFactory

Parameters:

poolName - the name of the pool

poolStats - a PoolStats instance to use

Returns:

a IMetricsTracker implementation instance