Package io.opentelemetry.instrumentation.spring.webmvc.v6_0

Class SpringWebMvcTelemetryBuilder

java.lang.Object

io.opentelemetry.instrumentation.spring.webmvc.v6_0.SpringWebMvcTelemetryBuilder

public final class SpringWebMvcTelemetryBuilder
extends Object

A builder of SpringWebMvcTelemetry.

Method Summary

Modifier and Type	Method	Description
SpringWebMvcTelemetryBuilder	addAttributesExtractor(io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse> attributesExtractor)	Adds an additional AttributesExtractor to invoke to set attributes to instrumented items.
SpringWebMvcTelemetry	build()	Returns a new SpringWebMvcTelemetry with the settings of this SpringWebMvcTelemetryBuilder.
SpringWebMvcTelemetryBuilder	setCapturedRequestHeaders(Collection<String> requestHeaders)	Configures the HTTP request headers that will be captured as span attributes.
SpringWebMvcTelemetryBuilder	setCapturedResponseHeaders(Collection<String> responseHeaders)	Configures the HTTP response headers that will be captured as span attributes.
SpringWebMvcTelemetryBuilder	setKnownMethods(Collection<String> knownMethods)	Configures the instrumentation to recognize an alternative set of HTTP request methods.
SpringWebMvcTelemetryBuilder	setSpanNameExtractor(Function<io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor<jakarta.servlet.http.HttpServletRequest>,io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor<jakarta.servlet.http.HttpServletRequest>> spanNameExtractor)	Sets custom SpanNameExtractor via transform function.

Methods inherited from class java.lang.Object

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

Method Details

addAttributesExtractor

@CanIgnoreReturnValue
public SpringWebMvcTelemetryBuilder addAttributesExtractor(io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<jakarta.servlet.http.HttpServletRequest,jakarta.servlet.http.HttpServletResponse> attributesExtractor)

Adds an additional AttributesExtractor to invoke to set attributes to instrumented items.

setCapturedRequestHeaders

@CanIgnoreReturnValue
public SpringWebMvcTelemetryBuilder setCapturedRequestHeaders(Collection<String> requestHeaders)

Configures the HTTP request headers that will be captured as span attributes.

Parameters:

requestHeaders - A list of HTTP header names.

setCapturedResponseHeaders

@CanIgnoreReturnValue
public SpringWebMvcTelemetryBuilder setCapturedResponseHeaders(Collection<String> responseHeaders)

Configures the HTTP response headers that will be captured as span attributes.

Parameters:

responseHeaders - A list of HTTP header names.

setSpanNameExtractor

@CanIgnoreReturnValue
public SpringWebMvcTelemetryBuilder setSpanNameExtractor(Function<io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor<jakarta.servlet.http.HttpServletRequest>,io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor<jakarta.servlet.http.HttpServletRequest>> spanNameExtractor)

Sets custom SpanNameExtractor via transform function.

setKnownMethods

@CanIgnoreReturnValue
public SpringWebMvcTelemetryBuilder setKnownMethods(Collection<String> knownMethods)

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

By default, this instrumentation defines "known" methods as the ones listed in RFC9110 and the PATCH method defined in RFC5789.

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.

See Also:

• HttpServerAttributesExtractorBuilder.setKnownMethods(Collection)

build

public SpringWebMvcTelemetry build()

Returns a new SpringWebMvcTelemetry with the settings of this SpringWebMvcTelemetryBuilder.