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.
    • setRequestHeaders

      @CanIgnoreReturnValue public SpringWebMvcTelemetryBuilder setRequestHeaders(io.opentelemetry.instrumentation.api.config.IncludeExclude requestHeaders)
      Configures which HTTP request headers are captured as span attributes.

      Header values are captured under the http.request.header.<key> attribute key. The <key> part in the attribute key is the lowercase header name.

      Selector patterns are matched case-insensitively, since HTTP header names are case-insensitive. ? matches one character and * matches any number of characters, including none. Excluded patterns take precedence over included patterns. A selector with no included patterns captures every header that is not excluded, and an empty selector captures no headers.

    • setCapturedRequestHeaders

      @Deprecated @CanIgnoreReturnValue public SpringWebMvcTelemetryBuilder setCapturedRequestHeaders(Collection<String> requestHeaders)
      Deprecated.
      Use setRequestHeaders(IncludeExclude) instead, which matches glob patterns rather than literal header names. May be removed in the next minor release.
      Configures HTTP request headers to capture as span attributes.

      The header names are matched literally, so * and ? are not treated as glob patterns.

      Parameters:
      requestHeaders - HTTP header names to capture.
    • setResponseHeaders

      @CanIgnoreReturnValue public SpringWebMvcTelemetryBuilder setResponseHeaders(io.opentelemetry.instrumentation.api.config.IncludeExclude responseHeaders)
      Configures which HTTP response headers are captured as span attributes.

      Header values are captured under the http.response.header.<key> attribute key. The <key> part in the attribute key is the lowercase header name.

      Selector patterns are matched case-insensitively, since HTTP header names are case-insensitive. ? matches one character and * matches any number of characters, including none. Excluded patterns take precedence over included patterns. A selector with no included patterns captures every header that is not excluded, and an empty selector captures no headers.

    • setCapturedResponseHeaders

      @Deprecated @CanIgnoreReturnValue public SpringWebMvcTelemetryBuilder setCapturedResponseHeaders(Collection<String> responseHeaders)
      Deprecated.
      Use setResponseHeaders(IncludeExclude) instead, which matches glob patterns rather than literal header names. May be removed in the next minor release.
      Configures HTTP response headers to capture as span attributes.

      The header names are matched literally, so * and ? are not treated as glob patterns.

      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.