Class SpringWebfluxClientTelemetryBuilder

java.lang.Object
io.opentelemetry.instrumentation.spring.webflux.v5_3.SpringWebfluxClientTelemetryBuilder

public final class SpringWebfluxClientTelemetryBuilder extends Object
  • Method Details

    • addAttributesExtractor

      @CanIgnoreReturnValue public SpringWebfluxClientTelemetryBuilder addAttributesExtractor(io.opentelemetry.instrumentation.api.instrumenter.AttributesExtractor<org.springframework.web.reactive.function.client.ClientRequest, org.springframework.web.reactive.function.client.ClientResponse> attributesExtractor)
      Adds an AttributesExtractor to extract attributes from requests and responses. Executed after all default extractors.
    • setRequestHeaders

      @CanIgnoreReturnValue public SpringWebfluxClientTelemetryBuilder 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 SpringWebfluxClientTelemetryBuilder 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 SpringWebfluxClientTelemetryBuilder 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 SpringWebfluxClientTelemetryBuilder 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.
    • setKnownMethods

      @CanIgnoreReturnValue public SpringWebfluxClientTelemetryBuilder 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)
    • setSpanNameExtractorCustomizer

      @CanIgnoreReturnValue public SpringWebfluxClientTelemetryBuilder setSpanNameExtractorCustomizer(UnaryOperator<io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor<org.springframework.web.reactive.function.client.ClientRequest>> spanNameExtractorCustomizer)
      Customizes the SpanNameExtractor by transforming the default instance.
    • build

      Returns a new instance with the configured settings.