Package io.opentelemetry.instrumentation.spring.webflux.v5_3

Class SpringWebfluxClientTelemetryBuilder

java.lang.Object
io.opentelemetry.instrumentation.spring.webflux.v5_3.SpringWebfluxClientTelemetryBuilder
public final class SpringWebfluxClientTelemetryBuilder extends Object
A builder of SpringWebfluxClientTelemetry.

  • 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 additional AttributesExtractor to invoke to set attributes to instrumented items for WebClient.

    • setCapturedRequestHeaders

      @CanIgnoreReturnValue public SpringWebfluxClientTelemetryBuilder setCapturedRequestHeaders(Collection<String> requestHeaders)
      Configures the HTTP WebClient request headers that will be captured as span attributes.
      Parameters:
      requestHeaders - A list of HTTP header names.

    • setCapturedResponseHeaders

      @CanIgnoreReturnValue public SpringWebfluxClientTelemetryBuilder setCapturedResponseHeaders(Collection<String> responseHeaders)
      Configures the HTTP WebClient response headers that will be captured as span attributes.
      Parameters:
      responseHeaders - A list of HTTP header names.

    • setKnownMethods

      @CanIgnoreReturnValue public SpringWebfluxClientTelemetryBuilder setKnownMethods(Collection<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:
      • HttpClientAttributesExtractorBuilder.setKnownMethods(Collection)

    • setSpanNameExtractor

      @CanIgnoreReturnValue public SpringWebfluxClientTelemetryBuilder setSpanNameExtractor(Function<io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor<org.springframework.web.reactive.function.client.ClientRequest>,io.opentelemetry.instrumentation.api.instrumenter.SpanNameExtractor<org.springframework.web.reactive.function.client.ClientRequest>> clientSpanNameExtractor)
      Sets custom client SpanNameExtractor via transform function.

    • build

      public SpringWebfluxClientTelemetry build()
      Returns a new SpringWebfluxClientTelemetry with the settings of this SpringWebfluxClientTelemetryBuilder.