reactor.pool.introspection.micrometer

Class Micrometer

java.lang.Object

reactor.pool.introspection.micrometer.Micrometer

public final class Micrometer
extends Object

Micrometer supporting utilities for instrumentation of reactor-pool.

Author:

Simon Baslé

Constructor Summary

Constructors

Constructor and Description
Micrometer()

Method Summary

Modifier and Type	Method and Description
static void	gaugesOf(InstrumentedPool.PoolMetrics poolMetrics, String poolName, io.micrometer.core.instrument.MeterRegistry meterRegistry) Create a PoolGaugesBinder and bind to the provided MeterRegistry.
static <POOLABLE> InstrumentedPool<POOLABLE>	instrumentedPool(PoolBuilder<POOLABLE,?> poolBuilder, String poolName, io.micrometer.core.instrument.MeterRegistry meterRegistry) Create an InstrumentedPool starting from the provided PoolBuilder.
static PoolMetricsRecorder	recorder(String poolName, io.micrometer.core.instrument.MeterRegistry meterRegistry) Create a PoolMetricsRecorder publishing timers and other meters to a provided MeterRegistry.

Methods inherited from class java.lang.Object

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

Constructor Detail

Micrometer

public Micrometer()

Method Detail

instrumentedPool

public static <POOLABLE> InstrumentedPool<POOLABLE> instrumentedPool(PoolBuilder<POOLABLE,?> poolBuilder,
                                                                     String poolName,
                                                                     io.micrometer.core.instrument.MeterRegistry meterRegistry)

Create an InstrumentedPool starting from the provided PoolBuilder. The pool publishes metrics to a Micrometer MeterRegistry. One can differentiate between pools thanks to the provided poolName, which will be set on all meters as the value for the PoolMetersDocumentation.CommonTags.POOL_NAME tag.

The steps involved are as follows:

1. create a PoolMetricsRecorder similar to recorder(String, MeterRegistry)
2. mutate the builder to use that recorder by calling PoolBuilder.metricsRecorder(PoolMetricsRecorder)
3. create an InstrumentedPool via PoolBuilder.buildPool()
4. instrument the InstrumentedPool.PoolMetrics via gaugesOf(InstrumentedPool.PoolMetrics, String, MeterRegistry)
5. return that InstrumentedPool instance

Type Parameters:

POOLABLE - the type of resources in the pool

Parameters:

poolBuilder - a pre-configured PoolBuilder on which to configure a PoolMetricsRecorder

poolName - the tag value to use on the gauges and the recorder's meters to differentiate between pools

meterRegistry - the registry to use for the gauges and the recorder's meters

Returns:

a new InstrumentedPool with a Micrometer recorder and with gauges attached

See Also:

PoolMetersDocumentation

gaugesOf

public static void gaugesOf(InstrumentedPool.PoolMetrics poolMetrics,
                            String poolName,
                            io.micrometer.core.instrument.MeterRegistry meterRegistry)

Create a PoolGaugesBinder and bind to the provided MeterRegistry. This registers gauges around the InstrumentedPool's InstrumentedPool.PoolMetrics. One can differentiate between pools thanks to the provided poolName, which will be set on all meters as the value for the PoolMetersDocumentation.CommonTags.POOL_NAME tag.

PoolMetersDocumentation include the gauges which are:

• PoolMetersDocumentation.ACQUIRED
• PoolMetersDocumentation.ALLOCATED,
• PoolMetersDocumentation.IDLE
• PoolMetersDocumentation.PENDING_ACQUIRE

Parameters:

poolMetrics - the InstrumentedPool.PoolMetrics to turn into gauges

poolName - the tag value to use on the gauges to differentiate between pools

meterRegistry - the registry to use for the gauges

See Also:

PoolGaugesBinder, PoolMetersDocumentation, instrumentedPool(PoolBuilder, String, MeterRegistry)

recorder

public static PoolMetricsRecorder recorder(String poolName,
                                           io.micrometer.core.instrument.MeterRegistry meterRegistry)

Create a PoolMetricsRecorder publishing timers and other meters to a provided MeterRegistry. One can differentiate between pools thanks to the provided poolName, which will be set on all meters as the value for the PoolMetersDocumentation.CommonTags.POOL_NAME tag.

PoolMetersDocumentation include the recorder-specific meters which are:

• PoolMetersDocumentation.ALLOCATION
• PoolMetersDocumentation.DESTROYED,
• PoolMetersDocumentation.RECYCLED
• PoolMetersDocumentation.RESET
• PoolMetersDocumentation.SUMMARY_IDLENESS
• PoolMetersDocumentation.SUMMARY_LIFETIME

Parameters:

poolName - the tag value to use on the gauges and the recorder's meters to differentiate between pools

meterRegistry - the registry to use for the recorder's meters

Returns:

a Micrometer PoolMetricsRecorder

See Also:

PoolMetersDocumentation, instrumentedPool(PoolBuilder, String, MeterRegistry)