com.zaxxer.hikari.metrics

Interface IMetricsTracker

All Known Implementing Classes:

CodaHaleMetricsTracker, MetricsTracker

public interface IMetricsTracker

Author:

Brett Wooldridge

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IMetricsTracker.MetricsContext A base instance of a MetricsContext.

Method Summary

Modifier and Type	Method and Description
int	getActiveConnections() Get the current number of active (in-use) connections.
int	getIdleConnections() Get the current number of idle connections.
int	getThreadsAwaitingConnection() Get the current number of threads awaiting a connection.
int	getTotalConnections() Get the current total number of connections.
IMetricsTracker.MetricsContext	recordConnectionRequest(long startTime) This method is called when a connection request starts.
void	recordConnectionUsage(long usageMilleseconds) This method is called when a Connection is closed, with the total time in milliseconds that the Connection was out of the pool.

Method Detail

recordConnectionRequest

IMetricsTracker.MetricsContext recordConnectionRequest(long startTime)

This method is called when a connection request starts. The IMetricsTracker.MetricsContext.stop() method will be called at the completion of the connection request, whether or not an exception occurred.

Parameters:

startTime - the timestamp of the start time as returned by System.currentTimeMillis()

Returns:

an instance of MetricsContext

recordConnectionUsage

void recordConnectionUsage(long usageMilleseconds)

This method is called when a Connection is closed, with the total time in milliseconds that the Connection was out of the pool.

Parameters:

usageMilleseconds - the Connection usage time in milliseconds

getIdleConnections

int getIdleConnections()

Get the current number of idle connections.

Returns:

the number of idle connections in the pool

getActiveConnections

int getActiveConnections()

Get the current number of active (in-use) connections.

Returns:

the number of active connections in the pool

getTotalConnections

int getTotalConnections()

Get the current total number of connections.

Returns:

the total number of connections in the pool

getThreadsAwaitingConnection

int getThreadsAwaitingConnection()

Get the current number of threads awaiting a connection.

Returns:

the number of awaiting threads