Class SpringWebMvcTelemetryBuilder

java.lang.Object
io.opentelemetry.instrumentation.spring.webmvc.v5_3.SpringWebMvcTelemetryBuilder

public final class SpringWebMvcTelemetryBuilder extends Object
  • Method Details

    • addAttributesExtractor

      @CanIgnoreReturnValue public SpringWebMvcTelemetryBuilder addAttributesExtractor(io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<javax.servlet.http.HttpServletRequest,javax.servlet.http.HttpServletResponse> attributesExtractor)
      Adds an AttributesExtractor to extract attributes from requests and responses. Executed after all default extractors.
    • setCapturedRequestHeaders

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

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

      @CanIgnoreReturnValue public SpringWebMvcTelemetryBuilder setSpanNameExtractorCustomizer(UnaryOperator<io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor<javax.servlet.http.HttpServletRequest>> spanNameExtractorCustomizer)
      Customizes the SpanNameExtractor by transforming the default instance.
    • setKnownMethods

      @CanIgnoreReturnValue public SpringWebMvcTelemetryBuilder 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:
      • HttpServerAttributesExtractorBuilder.setKnownMethods(Collection)
    • build

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