Package io.opentelemetry.instrumentation.api.semconv.http

Class HttpServerAttributesExtractorBuilder<REQUEST,RESPONSE>

java.lang.Object

io.opentelemetry.instrumentation.api.semconv.http.HttpServerAttributesExtractorBuilder<REQUEST,RESPONSE>

public final class HttpServerAttributesExtractorBuilder<REQUEST,RESPONSE>
extends Object

A builder of HttpServerAttributesExtractor.

Since:

2.0.0

Method Summary

Modifier and Type	Method	Description
AttributesExtractor<REQUEST,RESPONSE>	build()	Returns a new HttpServerAttributesExtractor with the settings of this HttpServerAttributesExtractorBuilder.
HttpServerAttributesExtractorBuilder<REQUEST,RESPONSE>	setCapturedRequestHeaders(List<String> requestHeaders)	Configures the HTTP response headers that will be captured as span attributes as described in HTTP semantic conventions.
HttpServerAttributesExtractorBuilder<REQUEST,RESPONSE>	setCapturedResponseHeaders(List<String> responseHeaders)	Configures the HTTP response headers that will be captured as span attributes as described in HTTP semantic conventions.
HttpServerAttributesExtractorBuilder<REQUEST,RESPONSE>	setKnownMethods(Set<String> knownMethods)	Configures the extractor to recognize an alternative set of HTTP request methods.

Methods inherited from class java.lang.Object

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

Method Details

setCapturedRequestHeaders

@CanIgnoreReturnValue
public HttpServerAttributesExtractorBuilder<REQUEST,RESPONSE> setCapturedRequestHeaders(List<String> requestHeaders)

Configures the HTTP response headers that will be captured as span attributes as described in HTTP semantic conventions.

The HTTP request header values will be captured under the http.request.header.<key> attribute key. The <key> part in the attribute key is the lowercase header name.

Parameters:

requestHeaders - A list of HTTP header names.

setCapturedResponseHeaders

@CanIgnoreReturnValue
public HttpServerAttributesExtractorBuilder<REQUEST,RESPONSE> setCapturedResponseHeaders(List<String> responseHeaders)

Configures the HTTP response headers that will be captured as span attributes as described in HTTP semantic conventions.

The HTTP response header values will be captured under the http.response.header.<key> attribute key. The <key> part in the attribute key is the lowercase header name.

Parameters:

responseHeaders - A list of HTTP header names.

setKnownMethods

@CanIgnoreReturnValue
public HttpServerAttributesExtractorBuilder<REQUEST,RESPONSE> setKnownMethods(Set<String> knownMethods)

Configures the extractor to recognize an alternative set of HTTP request methods.

By default, this extractor defines "known" methods as the ones listed in RFC9110 and the PATCH method defined in RFC5789. If an unknown method is encountered, the extractor will use the value "_OTHER" instead of it and put the original value in an extra http.request.method_original attribute.

Note: calling this method overrides the default known method sets completely; it does not supplement it.

Parameters:

knownMethods - A set of recognized HTTP request methods.

build

public AttributesExtractor<REQUEST,RESPONSE> build()

Returns a new HttpServerAttributesExtractor with the settings of this HttpServerAttributesExtractorBuilder.

See Also:

• InstrumenterBuilder.addAttributesExtractor(AttributesExtractor)