Package io.opentelemetry.instrumentation.spring.web.v3_1

Class SpringWebTelemetryBuilder

java.lang.Object
io.opentelemetry.instrumentation.spring.web.v3_1.SpringWebTelemetryBuilder
public final class SpringWebTelemetryBuilder extends Object
Builder for SpringWebTelemetry.

  • Method Details

    • addAttributesExtractor

      @CanIgnoreReturnValue public SpringWebTelemetryBuilder addAttributesExtractor(io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<org.springframework.http.HttpRequest,org.springframework.http.client.ClientHttpResponse> attributesExtractor)
      Adds an AttributesExtractor to extract attributes from requests and responses. Executed after all default extractors.

    • setCapturedRequestHeaders

      @CanIgnoreReturnValue public SpringWebTelemetryBuilder setCapturedRequestHeaders(Collection<String> requestHeaders)
      Configures HTTP request headers to capture as span attributes.
      Parameters:
      requestHeaders - HTTP header names to capture.

    • setCapturedResponseHeaders

      @CanIgnoreReturnValue public SpringWebTelemetryBuilder setCapturedResponseHeaders(Collection<String> responseHeaders)
      Configures HTTP response headers to capture as span attributes.
      Parameters:
      responseHeaders - HTTP header names to capture.

    • setSpanNameExtractorCustomizer

      @CanIgnoreReturnValue public SpringWebTelemetryBuilder setSpanNameExtractorCustomizer(UnaryOperator<io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor<org.springframework.http.HttpRequest>> spanNameExtractorCustomizer)
      Customizes the SpanNameExtractor by transforming the default instance.

    • setKnownMethods

      @CanIgnoreReturnValue public SpringWebTelemetryBuilder setKnownMethods(Collection<String> knownMethods)
      Configures recognized HTTP request methods.

      By default, recognizes methods from RFC9110 and PATCH from RFC5789.

      Note: This overrides defaults completely; it does not supplement them.

      Parameters:
      knownMethods - HTTP request methods to recognize.
      See Also:
      • HttpClientAttributesExtractorBuilder.setKnownMethods(Collection)

    • build

      public SpringWebTelemetry build()
      Returns a new instance with the configured settings.