io.r2dbc.pool

Interface PoolMetrics

public interface PoolMetrics

An object that can be used to get live information about a ConnectionPool, suitable for gauge metrics.

getXxx methods are configuration accessors, their values that won't change over time, whereas other methods can be used as gauges to introspect the current state of the pool.

Author:

Mark Paluch

Method Summary

Modifier and Type	Method and Description
int	acquiredSize() Measure the current number of connections that have been successfully ConnectionPool.create() acquired} and are in active use.
int	allocatedSize() Measure the current number of allocated connections in the ConnectionPool, acquired or idle.
int	getMaxAllocatedSize() Get the maximum number of live connections this ConnectionPool will allow.
int	getMaxPendingAcquireSize() Get the maximum number of ConnectionPool.create() this ConnectionPool can queue in a pending state when no available connection is immediately handy (and the ConnectionPool cannot allocate more connections).
int	idleSize() Measure the current number of idle connections in the ConnectionPool.
int	pendingAcquireSize() Measure the current number of "pending" ConnectionPool.create() acquire Monos in the ConnectionPool.

Method Detail

acquiredSize

int acquiredSize()

Measure the current number of connections that have been successfully ConnectionPool.create() acquired} and are in active use.

Returns:

the number of acquired connections

allocatedSize

int allocatedSize()

Measure the current number of allocated connections in the ConnectionPool, acquired or idle.

Returns:

the total number of allocated connections managed by the Pool

idleSize

int idleSize()

Measure the current number of idle connections in the ConnectionPool.

Note that some connections might be lazily evicted when they're next considered for an incoming ConnectionPool.create() call. Such connections would still count towards this method.

Returns:

the number of idle connections

pendingAcquireSize

int pendingAcquireSize()

Measure the current number of "pending" ConnectionPool.create() acquire Monos in the ConnectionPool.

An acquire is in the pending state when it is attempted at a point when no idle connections is available in the pool, and no new connection can be created.

Returns:

the number of pending acquire

getMaxAllocatedSize

int getMaxAllocatedSize()

Get the maximum number of live connections this ConnectionPool will allow.

A ConnectionPool might be unbounded, in which case this method returns Integer.MAX_VALUE.

Returns:

the maximum number of live connections that can be allocated by the ConnectionPool.

getMaxPendingAcquireSize

int getMaxPendingAcquireSize()

Get the maximum number of ConnectionPool.create() this ConnectionPool can queue in a pending state when no available connection is immediately handy (and the ConnectionPool cannot allocate more connections).

A ConnectionPool pending queue might be unbounded, in which case this method returns Integer.MAX_VALUE.

Returns:

the maximum number of pending acquire that can be enqueued by the ConnectionPool.