org.apache.hc.client5.http.observation.binder

Class ConnPoolMetersAsync

java.lang.Object

org.apache.hc.client5.http.observation.binder.ConnPoolMetersAsync

All Implemented Interfaces:

io.micrometer.core.instrument.binder.MeterBinder

public final class ConnPoolMetersAsync
extends Object
implements io.micrometer.core.instrument.binder.MeterBinder

Registers connection-pool gauges for an HttpAsyncClientBuilder.

Exposes:

• <prefix>.pool.leased – number of leased connections
• <prefix>.pool.available – number of available (idle) connections
• <prefix>.pool.pending – number of pending connection requests

The prefix and any common tags come from MetricConfig.

Usage

 MeterRegistry meters = new PrometheusMeterRegistry(PrometheusConfig.DEFAULT);
 MetricConfig mc = MetricConfig.builder().prefix("http_client").build();

 HttpAsyncClientBuilder b = HttpAsyncClients.custom()
     .setConnectionManager(PoolingAsyncClientConnectionManagerBuilder.create().build());

 // After the async connection manager is attached to the builder:
 ConnPoolMetersAsync.bindTo(b, meters, mc);
 

Note: This binder reads the async connection manager from the HttpAsyncClientBuilder. If the builder has no manager attached or it does not implement ConnPoolControl, this method is a no-op.

Since:

5.6

Method Summary

Modifier and Type	Method and Description
static void	bindTo(HttpAsyncClientBuilder builder, io.micrometer.core.instrument.MeterRegistry registry) Binds pool gauges using MetricConfig.DEFAULT.
static void	bindTo(HttpAsyncClientBuilder builder, io.micrometer.core.instrument.MeterRegistry registry, MetricConfig mc) Binds pool gauges for the async connection manager currently attached to the builder.
void	bindTo(io.micrometer.core.instrument.MeterRegistry registry)

Methods inherited from class java.lang.Object

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

Method Detail

bindTo

public void bindTo(io.micrometer.core.instrument.MeterRegistry registry)

Specified by:

bindTo in interface io.micrometer.core.instrument.binder.MeterBinder

bindTo

public static void bindTo(HttpAsyncClientBuilder builder,
                          io.micrometer.core.instrument.MeterRegistry registry,
                          MetricConfig mc)

Binds pool gauges for the async connection manager currently attached to the builder. If the builder has no connection manager or it does not implement ConnPoolControl, this method is a no-op.

Parameters:

builder - async client builder

registry - meter registry

mc - metric configuration (prefix, common tags)

Since:

5.6

bindTo

public static void bindTo(HttpAsyncClientBuilder builder,
                          io.micrometer.core.instrument.MeterRegistry registry)

Binds pool gauges using MetricConfig.DEFAULT.

Parameters:

builder - async client builder

registry - meter registry

Since:

5.6