Class AutoHttpMetricsConfig.BuilderBase.AutoHttpMetricsConfigImpl

java.lang.Object

io.helidon.webserver.observe.metrics.AutoHttpMetricsConfig.BuilderBase.AutoHttpMetricsConfigImpl

All Implemented Interfaces:

Prototype.Api, AutoHttpMetricsConfig

Enclosing class:

AutoHttpMetricsConfig.BuilderBase<BUILDER extends AutoHttpMetricsConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends AutoHttpMetricsConfig>

protected static class AutoHttpMetricsConfig.BuilderBase.AutoHttpMetricsConfigImpl
extends Object
implements AutoHttpMetricsConfig

Generated implementation of the prototype, can be extended by descendant prototype implementations.

Nested Class Summary

Nested classes/interfaces inherited from interface AutoHttpMetricsConfig

AutoHttpMetricsConfig.Builder, AutoHttpMetricsConfig.BuilderBase<BUILDER, PROTOTYPE>

Modifier and Type	Interface	Description
static class	AutoHttpMetricsConfig.Builder	Fluent API builder for AutoHttpMetricsConfig.
static class	AutoHttpMetricsConfig.BuilderBase<BUILDER extends AutoHttpMetricsConfig.BuilderBase<BUILDER, PROTOTYPE>, PROTOTYPE extends AutoHttpMetricsConfig>	Fluent API builder base for AutoHttpMetricsConfig.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AutoHttpMetricsConfigImpl(AutoHttpMetricsConfig.BuilderBase<?,?> builder)	Create an instance providing a builder.

Method Summary

Modifier and Type	Method	Description
boolean	enabled()	Whether automatic metrics collection as a whole is enabled.
boolean	equals(Object o)
int	hashCode()
List<String>	knownMethods()	Exact, case-sensitive HTTP methods to be used in the HTTP method tag for automatic metrics, defaulted to the standard HTTP methods; assigning this value fully replaces the set of method names.
List<String>	optIn()	Elective attribute for which to opt in.
List<AutoHttpMetricsPathConfig>	paths()	Automatic metrics collection settings.
Set<String>	sockets()	Socket names for sockets to be instrumented with automatic metrics.
String	toString()
boolean	useUpdatedHttpMetrics()	Deprecated.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AutoHttpMetricsConfig

isMeasured, isOptedIn

Modifier and Type	Method	Description
default boolean	isMeasured(Method method, UriPath uriPath)	Decides whether the specified HTTP method and path should be measured.
default boolean	isOptedIn(String meterName, String attributeName)	Returns whether the configuration indicates if the user has opted to have specified attribute (tag) added to meters for the specified meter name.

Constructor Details

AutoHttpMetricsConfigImpl

protected AutoHttpMetricsConfigImpl(AutoHttpMetricsConfig.BuilderBase<?,?> builder)

Create an instance providing a builder.

Parameters:

builder - extending builder base of this prototype

Method Details

enabled

public boolean enabled()

Description copied from interface: AutoHttpMetricsConfig

Whether automatic metrics collection as a whole is enabled.

Specified by:

enabled in interface AutoHttpMetricsConfig

Returns:

automatic metrics collection enabled

sockets

public Set<String> sockets()

Description copied from interface: AutoHttpMetricsConfig

Socket names for sockets to be instrumented with automatic metrics. Defaults to all sockets.

Specified by:

sockets in interface AutoHttpMetricsConfig

Returns:

socket names

paths

public List<AutoHttpMetricsPathConfig> paths()

Description copied from interface: AutoHttpMetricsConfig

Automatic metrics collection settings. Default excludes built-in Helidon paths (e.g., metrics, health). A request's path and HTTP method are checked against each entry under paths in order.

• If a request matches no entry, then the request is measured.
• If a request matches multiple entries, then the first match wins.

Specified by:

paths in interface AutoHttpMetricsConfig

Returns:

automatic metrics collection settings

optIn

public List<String> optIn()

Description copied from interface: AutoHttpMetricsConfig

Elective attribute for which to opt in. Each string in the list is of the form meter-name:attribute-name where meter-name is the name of the meter and attribute-name is the name of an attribute (tag) which is optional on that meter.

Specified by:

optIn in interface AutoHttpMetricsConfig

Returns:

opt-in attributes to be provided

knownMethods

public List<String> knownMethods()

Description copied from interface: AutoHttpMetricsConfig

Exact, case-sensitive HTTP methods to be used in the HTTP method tag for automatic metrics, defaulted to the standard HTTP methods; assigning this value fully replaces the set of method names.

Default known HTTP methods: CONNECT, DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT, QUERY, and TRACE. Unlisted methods are reported as _OTHER, so configurations that add additional method names must also include default methods they intend to retain.

Method names are matched exactly. See the OpenTelemetry semantic convention for HTTP request methods.

Specified by:

knownMethods in interface AutoHttpMetricsConfig

Returns:

known HTTP methods

useUpdatedHttpMetrics

@Deprecated
public boolean useUpdatedHttpMetrics()

Deprecated.

Description copied from interface: AutoHttpMetricsConfig

Retained for configuration compatibility with Helidon 4.x; Helidon 27 ignores the value and always uses the updated automatic HTTP metrics behavior.

Specified by:

useUpdatedHttpMetrics in interface AutoHttpMetricsConfig

Returns:

configured value, which does not affect automatic HTTP metrics behavior

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object