Skip to content

Meter pool leases automatically when CONN_POOL is on #908

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
rursprung wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Meter pool leases automatically when CONN_POOL is on #908

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
99 changes: 92 additions & 7 deletions ...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 @@ -49,6 +49,7 @@
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.pool.ConnPoolControl;
import org.apache.hc.core5.util.Args;
import org.apache.hc.core5.http.nio.ssl.TlsStrategy;

Expand Down Expand Up @@ -94,9 +95,37 @@
* 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). Pool lease
* timing is available when using {@link #meteredConnectionManager} or
* {@link #meteredAsyncConnectionManager}.</li>
* and CONN_POOL (pool gauges and pool lease metrics; classic and async
* variants).</li>
* </ul>
*
* <p><strong>Connection pool metrics</strong></p>
* <p>When {@link ObservingOptions.MetricSet#CONN_POOL} is enabled, the
* {@code enable(...)} methods operate on the connection manager that is
* attached to the builder <em>at the time of the call</em>:</p>
* <ul>
* <li>The connection manager is replaced with a metered wrapper (see
* {@link #meteredConnectionManager} and
* {@link #meteredAsyncConnectionManager}) that records the
* {@code <prefix>.pool.lease} timer and the {@code <prefix>.pool.leases}
* counter.</li>
* <li>If the connection manager is a connection pool
* ({@link ConnPoolControl}), the {@code <prefix>.pool.leased},
* {@code <prefix>.pool.available} and {@code <prefix>.pool.pending}
* gauges are bound to it.</li>
* <li>If the connection manager is already a {@link MeteredConnectionManager}
* or {@link MeteredAsyncConnectionManager} (for instance because it was
* wrapped explicitly or {@code enable(...)} was called before), it is not
* wrapped again. Lease metrics continue to be recorded by the existing
* wrapper.</li>
* <li>The connection manager shared flag
* ({@code setConnectionManagerShared(boolean)}) is not changed. The
* wrapper delegates {@code close} to the original connection manager.</li>
* <li>If no connection manager is attached to the builder, no pool metrics
* are installed. The connection manager that the builder creates by
* default in {@code build()} is not instrumented. Set the connection
* manager on the builder before calling {@code enable(...)} to get pool
* metrics.</li>
* </ul>
*
* <p><strong>Thread safety:</strong> This class is stateless. Methods may be
Expand Down Expand Up @@ -172,6 +201,10 @@ public static void enable(final HttpClientBuilder builder,
*
* <p>Installs interceptors at the <em>beginning</em> of the execution chain.</p>
*
* <p>If {@link ObservingOptions.MetricSet#CONN_POOL} is enabled, the connection manager
* attached to the builder is wrapped with pool-lease metrics and the pool gauges are
* bound to it. See the class documentation for details.</p>
*
* @param builder client builder to instrument
* @param obsReg observation registry; if {@code null} no observations are installed
* @param meterReg meter registry to register meters with (must not be {@code null})
Expand Down Expand Up @@ -204,7 +237,7 @@ public static void enable(final HttpClientBuilder builder,
builder.addExecInterceptorFirst(IO_ID, new IoByteCounterExec(meterReg, o, config));
}
if (o.metricSets.contains(ObservingOptions.MetricSet.CONN_POOL)) {
ConnPoolMeters.bindTo(builder, meterReg, config);
bindConnPoolMetrics(builder, meterReg, o, config);
}
}

Expand Down Expand Up @@ -262,6 +295,10 @@ public static void enable(final CachingHttpClientBuilder builder,
* <p>Interceptors are installed <em>after</em> the caching element so that
* metrics/observations reflect the actual exchange.</p>
*
* <p>If {@link ObservingOptions.MetricSet#CONN_POOL} is enabled, the connection manager
* attached to the builder is wrapped with pool-lease metrics and the pool gauges are
* bound to it. See the class documentation for details.</p>
*
* @param builder caching client builder to instrument
* @param obsReg observation registry; if {@code null} no observations are installed
* @param meterReg meter registry to register meters with (must not be {@code null})
Expand Down Expand Up @@ -295,7 +332,7 @@ public static void enable(final CachingHttpClientBuilder builder,
builder.addExecInterceptorAfter(ChainElement.CACHING.name(), IO_ID, new IoByteCounterExec(meterReg, o, config));
}
if (o.metricSets.contains(ObservingOptions.MetricSet.CONN_POOL)) {
ConnPoolMeters.bindTo(builder, meterReg, config);
bindConnPoolMetrics(builder, meterReg, o, config);
}
}

Expand Down Expand Up @@ -350,6 +387,10 @@ public static void enable(final HttpAsyncClientBuilder builder,
* Enables observations and metrics on an async client builder using explicit
* registries and {@link MetricConfig}.
*
* <p>If {@link ObservingOptions.MetricSet#CONN_POOL} is enabled, the connection manager
* attached to the builder is wrapped with pool-lease metrics and the pool gauges are
* bound to it. See the class documentation for details.</p>
*
* @param builder async client builder to instrument
* @param obsReg observation registry; if {@code null} no observations are installed
* @param meterReg meter registry to register meters with (must not be {@code null})
Expand Down Expand Up @@ -382,7 +423,7 @@ public static void enable(final HttpAsyncClientBuilder builder,
builder.addExecInterceptorFirst(IO_ID, new AsyncIoByteCounterExec(meterReg, o, config));
}
if (o.metricSets.contains(ObservingOptions.MetricSet.CONN_POOL)) {
ConnPoolMetersAsync.bindTo(builder, meterReg, config);
bindConnPoolMetrics(builder, meterReg, o, config);
}
}

Expand Down Expand Up @@ -439,6 +480,10 @@ public static void enable(final CachingHttpAsyncClientBuilder builder,
*
* <p>Interceptors are installed <em>after</em> the caching element.</p>
*
* <p>If {@link ObservingOptions.MetricSet#CONN_POOL} is enabled, the connection manager
* attached to the builder is wrapped with pool-lease metrics and the pool gauges are
* bound to it. See the class documentation for details.</p>
*
* @param builder caching async client builder to instrument
* @param obsReg observation registry; if {@code null} no observations are installed
* @param meterReg meter registry to register meters with (must not be {@code null})
Expand Down Expand Up @@ -472,7 +517,7 @@ public static void enable(final CachingHttpAsyncClientBuilder builder,
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);
bindConnPoolMetrics(builder, meterReg, o, config);
}
}

Expand Down Expand Up @@ -578,6 +623,46 @@ public static TlsStrategy meteredTlsStrategy(final TlsStrategy delegate,
return new MeteredTlsStrategy(delegate, meterReg, config, o);
}

/**
* Wraps the classic connection manager of the builder with pool-lease metrics
* and binds the pool gauges to it.
*/
private static void bindConnPoolMetrics(final HttpClientBuilder builder,
final MeterRegistry meterReg,
final ObservingOptions opts,
final MetricConfig config) {
final HttpClientConnectionManager cm = builder.getConnManager();
if (cm == null) {
return;
}
if (!(cm instanceof MeteredConnectionManager)) {
builder.setConnectionManager(meteredConnectionManager(cm, meterReg, opts, config));
}
if (cm instanceof ConnPoolControl) {
ConnPoolMeters.bindTo(builder, meterReg, config);
}
}

/**
* Wraps the async connection manager of the builder with pool-lease metrics
* and binds the pool gauges to it.
*/
private static void bindConnPoolMetrics(final HttpAsyncClientBuilder builder,
final MeterRegistry meterReg,
final ObservingOptions opts,
final MetricConfig config) {
final AsyncClientConnectionManager cm = builder.getConnManager();
if (cm == null) {
return;
}
if (!(cm instanceof MeteredAsyncConnectionManager)) {
builder.setConnectionManager(meteredAsyncConnectionManager(cm, meterReg, opts, config));
}
if (cm instanceof ConnPoolControl) {
ConnPoolMetersAsync.bindTo(builder, meterReg, config);
}
}

/**
* No instantiation.
*
Expand Down
Loading
Loading