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 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(List<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(List<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>,? extends io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor<? super jakarta.servlet.http.HttpServletRequest>> spanNameExtractor)
      Sets custom SpanNameExtractor via transform function.

    • setKnownMethods

      @CanIgnoreReturnValue public SpringWebMvcTelemetryBuilder setKnownMethods(Set<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(Set)

    • setEmitExperimentalHttpServerMetrics

      @CanIgnoreReturnValue public SpringWebMvcTelemetryBuilder setEmitExperimentalHttpServerMetrics(boolean emitExperimentalHttpServerMetrics)
      Configures the instrumentation to emit experimental HTTP server metrics.
      Parameters:
      emitExperimentalHttpServerMetrics - true if the experimental HTTP server metrics are to be emitted.

    • build

      public SpringWebMvcTelemetry build()
      Returns a new SpringWebMvcTelemetry with the settings of this SpringWebMvcTelemetryBuilder.