org.apache.hc.client5.http.observation.impl

Class MeteredTlsStrategy

java.lang.Object

org.apache.hc.client5.http.observation.impl.MeteredTlsStrategy

All Implemented Interfaces:

TlsStrategy

public final class MeteredTlsStrategy
extends Object
implements TlsStrategy

TlsStrategy decorator that records TLS handshake metrics via Micrometer.

Exposes the following meters (names are prefixed by MetricConfig.prefix):

• <prefix>.tls.handshake (timer) — TLS handshake latency
• <prefix>.tls.handshakes (counter) — handshake outcome count

Tags:

• result = ok|error|cancel
• sni (only when ObservingOptions.TagLevel#EXTENDED)
• plus any common tags

Since:

5.6

Constructor Summary

Constructors

Constructor and Description
MeteredTlsStrategy(TlsStrategy delegate, io.micrometer.core.instrument.MeterRegistry registry, MetricConfig mc, ObservingOptions opts) Primary constructor.
MeteredTlsStrategy(TlsStrategy delegate, io.micrometer.core.instrument.MeterRegistry registry, String prefix) Deprecated. Use MeteredTlsStrategy(TlsStrategy, MeterRegistry, MetricConfig, ObservingOptions) supplying MetricConfig and ObservingOptions.

Method Summary

Modifier and Type	Method and Description
boolean	upgrade(TransportSecurityLayer sessionLayer, HttpHost host, SocketAddress localAddress, SocketAddress remoteAddress, Object attachment, Timeout handshakeTimeout) Deprecated. Implementations should prefer the async overload; this remains to fulfill the interface.
void	upgrade(TransportSecurityLayer sessionLayer, NamedEndpoint endpoint, Object attachment, Timeout handshakeTimeout, FutureCallback<TransportSecurityLayer> callback)

Methods inherited from class java.lang.Object

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

Constructor Detail

MeteredTlsStrategy

public MeteredTlsStrategy(TlsStrategy delegate,
                          io.micrometer.core.instrument.MeterRegistry registry,
                          MetricConfig mc,
                          ObservingOptions opts)

Primary constructor.

Parameters:

delegate - TLS strategy to wrap

registry - meter registry

mc - metric configuration (prefix, common tags). If null, defaults are used.

opts - observing options (tag level). If null, ObservingOptions.DEFAULT is used.

MeteredTlsStrategy

@Deprecated
public MeteredTlsStrategy(TlsStrategy delegate,
                                       io.micrometer.core.instrument.MeterRegistry registry,
                                       String prefix)

Deprecated. Use MeteredTlsStrategy(TlsStrategy, MeterRegistry, MetricConfig, ObservingOptions) supplying MetricConfig and ObservingOptions.

Convenience constructor.

Method Detail

upgrade

public void upgrade(TransportSecurityLayer sessionLayer,
                    NamedEndpoint endpoint,
                    Object attachment,
                    Timeout handshakeTimeout,
                    FutureCallback<TransportSecurityLayer> callback)

Specified by:

upgrade in interface TlsStrategy

upgrade

@Deprecated
public boolean upgrade(TransportSecurityLayer sessionLayer,
                                    HttpHost host,
                                    SocketAddress localAddress,
                                    SocketAddress remoteAddress,
                                    Object attachment,
                                    Timeout handshakeTimeout)

Deprecated. Implementations should prefer the async overload; this remains to fulfill the interface.

Records metrics while delegating to the classic upgrade path.

Specified by:

upgrade in interface TlsStrategy