club.zhcs.lina.starter.monitor.metrics.http.PoolingHttpClientConnectionManagerMetricsBinder Maven / Gradle / Ivy

Go to download
package club.zhcs.lina.starter.monitor.metrics.http;

import org.apache.hc.client5.http.impl.io.PoolingHttpClientConnectionManager;
import org.apache.hc.core5.pool.ConnPoolControl;

/**
 * @author Kerbores([email protected])
 *
 */

import io.micrometer.common.lang.NonNull;
import io.micrometer.core.instrument.Gauge;
import io.micrometer.core.instrument.MeterRegistry;
import io.micrometer.core.instrument.Tag;
import io.micrometer.core.instrument.Tags;
import io.micrometer.core.instrument.binder.MeterBinder;

public class PoolingHttpClientConnectionManagerMetricsBinder implements MeterBinder {

    private final PoolingHttpClientConnectionManager poolingHttpClientConnectionManager;

    private final Iterable tags;

    /**
     * Creates a metrics binder for the given pooling connection pool control.
     * 
     * @param connPoolControl
     *            The connection pool control to monitor.
     * @param name
     *            Name of the connection pool control. Will be added as tag with
     *            the key "httpclient".
     * @param tags
     *            Tags to apply to all recorded metrics. Must be an even number
     *            of arguments representing key/value pairs of tags.
     */
    public PoolingHttpClientConnectionManagerMetricsBinder(PoolingHttpClientConnectionManager poolingHttpClientConnectionManager,
                                                           String name,
                                                           String... tags) {
        this(poolingHttpClientConnectionManager, name, Tags.of(tags));
    }

    /**
     * Creates a metrics binder for the given connection pool control.
     * 
     * @param connPoolControl
     *            The connection pool control to monitor.
     * @param name
     *            Name of the connection pool control. Will be added as tag with
     *            the key "httpclient".
     * @param tags
     *            Tags to apply to all recorded metrics.
     */
    public PoolingHttpClientConnectionManagerMetricsBinder(PoolingHttpClientConnectionManager poolingHttpClientConnectionManager,
                                                           String name,
                                                           Iterable tags) {
        this.poolingHttpClientConnectionManager = poolingHttpClientConnectionManager;
        this.tags = Tags.concat(tags, "httpclient", name);
    }

    @Override
    public void bindTo(@NonNull MeterRegistry registry) {
        registerTotalMetrics(registry);
    }

    private void registerTotalMetrics(MeterRegistry registry) {
        Gauge.builder("httpcomponents.httpclient.pool.total.max",
                      poolingHttpClientConnectionManager,
                      connPoolControl -> connPoolControl.getTotalStats().getMax())
             .description("The configured maximum number of allowed persistent connections for all routes.")
             .tags(tags)
             .register(registry);
        Gauge.builder("httpcomponents.httpclient.pool.total.connections",
                      poolingHttpClientConnectionManager,
                      connPoolControl -> connPoolControl.getTotalStats().getAvailable())
             .description("The number of persistent and available connections for all routes.")
             .tags(tags)
             .tag("state", "available")
             .register(registry);
        Gauge.builder("httpcomponents.httpclient.pool.total.connections",
                      poolingHttpClientConnectionManager,
                      connPoolControl -> connPoolControl.getTotalStats().getLeased())
             .description("The number of persistent and leased connections for all routes.")
             .tags(tags)
             .tag("state", "leased")
             .register(registry);
        Gauge.builder("httpcomponents.httpclient.pool.total.pending",
                      poolingHttpClientConnectionManager,
                      connPoolControl -> connPoolControl.getTotalStats().getPending())
             .description(
                          "The number of connection requests being blocked awaiting a free connection for all routes.")
             .tags(tags)
             .register(registry);
        Gauge.builder("httpcomponents.httpclient.pool.route.max.default",
                      poolingHttpClientConnectionManager,
                      ConnPoolControl::getDefaultMaxPerRoute)
             .description("The configured default maximum number of allowed persistent connections per route.")
             .tags(tags)
             .register(registry);
    }

}