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

Interface TracingSemanticConventions

public interface TracingSemanticConventions
Applies a particular set of semantic conventions to spans created automatically for requests.

Helidon creates a new instance of this interface for each request it traces by invoking TracingSemanticConventionsProvider#create.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    beforeEnd(Span span)
    Applies semantic conventions to the Span after Helidon has successfully processed the request and prepared the response and just before it ends the span; that is, Helidon has set the response status and entity (if any) and no exception escaped from the request processing.
    void
    beforeEnd(Span span, Exception e)
    Applies semantic conventions the Span after Helidon has attempted to process the request just before Helidon ends the span unsuccessfully (with an exception).
    void
    beforeStart(Span.Builder<?> spanBuilder)
    Applies semantic conventions to the Span.Builder just prior to Helidon using the span builder to create the span for the request.
    String
    spanName()
    Provides the span name Helidon should use to construct the Span.Builder.

  • Method Details

    • spanName

      String spanName()
      Provides the span name Helidon should use to construct the Span.Builder.
      Returns:
      span name

    • beforeStart

      void beforeStart(Span.Builder<?> spanBuilder)
      Applies semantic conventions to the Span.Builder just prior to Helidon using the span builder to create the span for the request.
      Parameters:
      spanBuilder - span builder to update

    • beforeEnd

      void beforeEnd(Span span)
      Applies semantic conventions to the Span after Helidon has successfully processed the request and prepared the response and just before it ends the span; that is, Helidon has set the response status and entity (if any) and no exception escaped from the request processing.

      The lack of an exception does not necessarily indicate the response has a successful status, only that the request was processed and the response prepared without error.

      Parameters:
      span - span about to be ended

    • beforeEnd

      void beforeEnd(Span span, Exception e)
      Applies semantic conventions the Span after Helidon has attempted to process the request just before Helidon ends the span unsuccessfully (with an exception). Implementations of this method should not assume that the response status or entity (if appropriate for a given response) have been set,
      Parameters:
      span - span about to be ended
      e - exception thrown as Helidon processed the request