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

Class ConnPoolMeters

java.lang.Object

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

All Implemented Interfaces:

io.micrometer.core.instrument.binder.MeterBinder

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

Registers connection pool gauges for a classic HttpClientBuilder.

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();

 HttpClientBuilder b = HttpClients.custom()
     .setConnectionManager(PoolingHttpClientConnectionManagerBuilder.create().build());

 // after the connection manager is attached to the builder:
 ConnPoolMeters.bindTo(b, meters, mc);
 

Note: This binder reads the connection manager from the HttpClientBuilder. Ensure the builder has a compatible connection manager (implementing ConnPoolControl) before calling bindTo.

Since:

5.6

Method Summary

Modifier and Type	Method and Description
static void	bindTo(HttpClientBuilder builder, io.micrometer.core.instrument.MeterRegistry registry) Binds pool gauges using MetricConfig.DEFAULT.
static void	bindTo(HttpClientBuilder builder, io.micrometer.core.instrument.MeterRegistry registry, MetricConfig mc) Binds pool gauges for the connection manager currently attached to the given 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(HttpClientBuilder builder,
                          io.micrometer.core.instrument.MeterRegistry registry,
                          MetricConfig mc)

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

Parameters:

builder - classic client builder

registry - meter registry

mc - metric configuration (prefix, common tags)

Since:

5.6

bindTo

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

Binds pool gauges using MetricConfig.DEFAULT.

Parameters:

builder - classic client builder

registry - meter registry

Since:

5.6