Package org.apache.camel.tracing

Class ActiveSpanManager

java.lang.Object
org.apache.camel.tracing.ActiveSpanManager
public final class ActiveSpanManager extends Object
Utility class for managing active spans as a stack associated with an exchange.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    ActiveSpanManager.Holder
    Simple holder for the currently active span and an optional reference to the parent holder.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    MDC_SPAN_ID
     
    static final String
    MDC_TRACE_ID
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static void
    activate(org.apache.camel.Exchange exchange, SpanAdapter span)
    This method activates the supplied span for the supplied exchange.
    static void
    deactivate(org.apache.camel.Exchange exchange)
    This method deactivates an existing active span associated with the supplied exchange.
    static void
    endScope(org.apache.camel.Exchange exchange)
    If underlying span is active, closes its scope without ending the span.
    static SpanAdapter
    getSpan(org.apache.camel.Exchange exchange)
    This method returns the current active span associated with the exchange.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Method Details

    • getSpan

      public static SpanAdapter getSpan(org.apache.camel.Exchange exchange)
      This method returns the current active span associated with the exchange.
      Parameters:
      exchange - The exchange
      Returns:
      The current active span, or null if none exists

    • activate

      public static void activate(org.apache.camel.Exchange exchange, SpanAdapter span)
      This method activates the supplied span for the supplied exchange. If an existing span is found for the exchange, this will be pushed onto a stack.
      Parameters:
      exchange - The exchange
      span - The span

    • deactivate

      public static void deactivate(org.apache.camel.Exchange exchange)
      This method deactivates an existing active span associated with the supplied exchange. Once deactivated, if a parent span is found associated with the stack for the exchange, it will be restored as the current span for that exchange.
      Parameters:
      exchange - The exchange

    • endScope

      public static void endScope(org.apache.camel.Exchange exchange)
      If underlying span is active, closes its scope without ending the span. This methods should be called after async execution is started on the same thread on which span was activated. ExchangeAsyncStartedEvent is used to notify about it.
      Parameters:
      exchange - The exchange