Skip to content

Add pool lease metrics and helpers for connection managers #799

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
arturobernalg wants to merge 1 commit into
base: master
Choose a base branch
from
+1,189 −40
Open

Add pool lease metrics and helpers for connection managers #799

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
117 changes: 116 additions & 1 deletion ...on/src/main/java/org/apache/hc/client5/http/observation/HttpClientObservationSupport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,16 +33,24 @@
import org.apache.hc.client5.http.impl.async.HttpAsyncClientBuilder;
import org.apache.hc.client5.http.impl.cache.CachingHttpAsyncClientBuilder;
import org.apache.hc.client5.http.impl.cache.CachingHttpClientBuilder;
import org.apache.hc.client5.http.DnsResolver;
import org.apache.hc.client5.http.impl.classic.HttpClientBuilder;
import org.apache.hc.client5.http.observation.binder.ConnPoolMeters;
import org.apache.hc.client5.http.observation.binder.ConnPoolMetersAsync;
import org.apache.hc.client5.http.observation.impl.MeteredAsyncConnectionManager;
import org.apache.hc.client5.http.observation.impl.MeteredConnectionManager;
import org.apache.hc.client5.http.observation.impl.ObservationAsyncExecInterceptor;
import org.apache.hc.client5.http.observation.impl.ObservationClassicExecInterceptor;
import org.apache.hc.client5.http.observation.impl.MeteredDnsResolver;
import org.apache.hc.client5.http.observation.impl.MeteredTlsStrategy;
import org.apache.hc.client5.http.observation.interceptors.AsyncIoByteCounterExec;
import org.apache.hc.client5.http.observation.interceptors.AsyncTimerExec;
import org.apache.hc.client5.http.observation.interceptors.IoByteCounterExec;
import org.apache.hc.client5.http.observation.interceptors.TimerExec;
import org.apache.hc.client5.http.io.HttpClientConnectionManager;
import org.apache.hc.client5.http.nio.AsyncClientConnectionManager;
import org.apache.hc.core5.util.Args;
import org.apache.hc.core5.http.nio.ssl.TlsStrategy;

/**
* Utility class that wires Micrometer / OpenTelemetry instrumentation into
Expand Down Expand Up @@ -86,7 +94,9 @@
* that surrounds each execution with a start/stop span.</li>
* <li>Metric interceptors according to {@link ObservingOptions.MetricSet}:
* BASIC (latency timer + response counter), IO (bytes in/out counters),
* and CONN_POOL (pool gauges; classic and async variants).</li>
* and CONN_POOL (pool gauges; classic and async variants). Pool lease
* timing is available when using {@link #meteredConnectionManager} or
* {@link #meteredAsyncConnectionManager}.</li>
* </ul>
*
* <p><strong>Thread safety:</strong> This class is stateless. Methods may be
Expand Down Expand Up @@ -461,6 +471,111 @@ public static void enable(final CachingHttpAsyncClientBuilder builder,
if (o.metricSets.contains(ObservingOptions.MetricSet.IO)) {
builder.addExecInterceptorAfter(ChainElement.CACHING.name(), IO_ID, new AsyncIoByteCounterExec(meterReg, o, config));
}
if (o.metricSets.contains(ObservingOptions.MetricSet.CONN_POOL)) {
ConnPoolMetersAsync.bindTo(builder, meterReg, config);
}
}

/**
* Wraps a classic connection manager with Micrometer pool-lease metrics if
* {@link ObservingOptions.MetricSet#CONN_POOL} is enabled. Otherwise returns
* the delegate unchanged.
*
* @param delegate connection manager to wrap
* @param meterReg meter registry to register meters with (must not be {@code null})
* @param opts observation/metric options; when {@code null} {@link ObservingOptions#DEFAULT} is used
* @param mc metric configuration; when {@code null} {@link MetricConfig#DEFAULT} is used
* @return metered connection manager or original delegate
* @since 5.7
*/
public static HttpClientConnectionManager meteredConnectionManager(final HttpClientConnectionManager delegate,
final MeterRegistry meterReg,
final ObservingOptions opts,
final MetricConfig mc) {
Args.notNull(delegate, "delegate");
Args.notNull(meterReg, "meterRegistry");
final ObservingOptions o = opts != null ? opts : ObservingOptions.DEFAULT;
final MetricConfig config = mc != null ? mc : MetricConfig.DEFAULT;
if (!o.metricSets.contains(ObservingOptions.MetricSet.CONN_POOL)) {
return delegate;
}
return new MeteredConnectionManager(delegate, meterReg, config, o);
}

/**
* Wraps an async connection manager with Micrometer pool-lease metrics if
* {@link ObservingOptions.MetricSet#CONN_POOL} is enabled. Otherwise returns
* the delegate unchanged.
*
* @param delegate connection manager to wrap
* @param meterReg meter registry to register meters with (must not be {@code null})
* @param opts observation/metric options; when {@code null} {@link ObservingOptions#DEFAULT} is used
* @param mc metric configuration; when {@code null} {@link MetricConfig#DEFAULT} is used
* @return metered connection manager or original delegate
* @since 5.7
*/
public static AsyncClientConnectionManager meteredAsyncConnectionManager(final AsyncClientConnectionManager delegate,
final MeterRegistry meterReg,
final ObservingOptions opts,
final MetricConfig mc) {
Args.notNull(delegate, "delegate");
Args.notNull(meterReg, "meterRegistry");
final ObservingOptions o = opts != null ? opts : ObservingOptions.DEFAULT;
final MetricConfig config = mc != null ? mc : MetricConfig.DEFAULT;
if (!o.metricSets.contains(ObservingOptions.MetricSet.CONN_POOL)) {
return delegate;
}
return new MeteredAsyncConnectionManager(delegate, meterReg, config, o);
}

/**
* Wraps a DNS resolver with Micrometer metrics if {@link ObservingOptions.MetricSet#DNS}
* is enabled. Otherwise returns the delegate unchanged.
*
* @param delegate underlying DNS resolver
* @param meterReg meter registry to register meters with (must not be {@code null})
* @param opts observation/metric options; when {@code null} {@link ObservingOptions#DEFAULT} is used
* @param mc metric configuration; when {@code null} {@link MetricConfig#DEFAULT} is used
* @return metered resolver or original delegate
* @since 5.7
*/
public static DnsResolver meteredDnsResolver(final DnsResolver delegate,
final MeterRegistry meterReg,
final ObservingOptions opts,
final MetricConfig mc) {
Args.notNull(delegate, "delegate");
Args.notNull(meterReg, "meterRegistry");
final ObservingOptions o = opts != null ? opts : ObservingOptions.DEFAULT;
final MetricConfig config = mc != null ? mc : MetricConfig.DEFAULT;
if (!o.metricSets.contains(ObservingOptions.MetricSet.DNS)) {
return delegate;
}
return new MeteredDnsResolver(delegate, meterReg, config, o);
}

/**
* Wraps a TLS strategy with Micrometer metrics if {@link ObservingOptions.MetricSet#TLS}
* is enabled. Otherwise returns the delegate unchanged.
*
* @param delegate TLS strategy to wrap
* @param meterReg meter registry to register meters with (must not be {@code null})
* @param opts observation/metric options; when {@code null} {@link ObservingOptions#DEFAULT} is used
* @param mc metric configuration; when {@code null} {@link MetricConfig#DEFAULT} is used
* @return metered strategy or original delegate
* @since 5.7
*/
public static TlsStrategy meteredTlsStrategy(final TlsStrategy delegate,
final MeterRegistry meterReg,
final ObservingOptions opts,
final MetricConfig mc) {
Args.notNull(delegate, "delegate");
Args.notNull(meterReg, "meterRegistry");
final ObservingOptions o = opts != null ? opts : ObservingOptions.DEFAULT;
final MetricConfig config = mc != null ? mc : MetricConfig.DEFAULT;
if (!o.metricSets.contains(ObservingOptions.MetricSet.TLS)) {
return delegate;
}
return new MeteredTlsStrategy(delegate, meterReg, config, o);
}

/**
Expand Down
5 changes: 5 additions & 0 deletions ...t5-observation/src/main/java/org/apache/hc/client5/http/observation/ObservingOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ public final class ObservingOptions {

/**
* Which metric groups to enable.
* <p>
* {@link MetricSet#TLS} and {@link MetricSet#DNS} are applied when using
* {@link org.apache.hc.client5.http.observation.HttpClientObservationSupport#meteredTlsStrategy}
* and {@link org.apache.hc.client5.http.observation.HttpClientObservationSupport#meteredDnsResolver}
* to wrap the underlying TLS strategy or DNS resolver.
*/
public enum MetricSet { BASIC, IO, CONN_POOL, TLS, DNS }

Expand Down
Loading
Loading