Module io.helidon.webserver.observe.tracing
Package io.helidon.webserver.observe.tracing

Class TracingObserver

java.lang.Object
io.helidon.webserver.observe.tracing.TracingObserver
All Implemented Interfaces:
RuntimeType.Api<TracingObserverConfig>, NamedService, Observer
public class TracingObserver extends Object implements Observer, RuntimeType.Api<TracingObserverConfig>
Observer that registers tracing endpoint, and collects all tracing checks.

  • Method Details

    • builder

      public static TracingObserverConfig.Builder builder()
      Create a new builder to configure Tracing observer.
      Returns:
      a new builder

    • create

      public static TracingObserver create(Tracer tracer)
      Create a tracing observer that is enabled for all paths and spans (that are enabled by default).
      Parameters:
      tracer - tracer to use for tracing spans created by this feature
      Returns:
      tracing observer to register with ObserveFeature}

    • create

      public static TracingObserver create(Tracer tracer, Config config)
      Create a new tracing observer based on Config.
      Parameters:
      tracer - tracer to use for tracing spans created by this feature
      config - to base this observer on
      Returns:
      a new tracing observer to register with ObserveFeature

    • create

      public static TracingObserver create(TracingObserverConfig config)
      Create a new Tracing observer using the provided configuration.
      Parameters:
      config - configuration
      Returns:
      a new observer

    • create

      public static TracingObserver create(Consumer<TracingObserverConfig.Builder> consumer)
      Create a new Tracing observer customizing its configuration.
      Parameters:
      consumer - configuration consumer
      Returns:
      a new observer

    • register

      public void register(ServerFeature.ServerFeatureContext featureContext, List<HttpRouting.Builder> observeEndpointRouting, UnaryOperator<String> endpointFunction)
      Description copied from interface: Observer
      Register the observer features, services, and/or filters. This is used by the observe feature. Do NOT use this method directly, kindly start with ObserveFeature and register it with the server builder.

      Implementations of observers should register all they need through an HttpFeature, to make sure the weight of the ObserveFeature is honored when routing is set up. If you do not use an HttpFeature, the registration will always happen later than the default (business) routing feature.

      Specified by:
      register in interface Observer
      Parameters:
      featureContext - access to all routing builders, for cases where this observer needs to register additional components to other sockets
      observeEndpointRouting - routing builders that expose observability endpoints, and this feature must use these to register any endpoints exposed for observability
      endpointFunction - function to obtain the final endpoint for observers that expose observe endpoints (such as /observe/health would be provider for health by default)

    • type

      public String type()
      Description copied from interface: Observer
      Type of this observer, to make sure we do not configure an observer both from ServiceLoader and using programmatic approach. If it is desired to have more than one observer of the same type, always use programmatic approach
      Specified by:
      type in interface NamedService
      Specified by:
      type in interface Observer
      Returns:
      type of this observer, should match ObserveProvider.type()

    • prototype

      public TracingObserverConfig prototype()
      Description copied from interface: Observer
      Configuration of this observer.
      Specified by:
      prototype in interface Observer
      Specified by:
      prototype in interface RuntimeType.Api<TracingObserverConfig>
      Returns:
      configuration of the observer