Interface InternalSpan

  • All Known Implementing Classes:
    NoopInternalSpan, ThresholdInternalSpan

    @Internal
    public interface InternalSpan
    The InternalSpan tracks the nitty gritty details of the request/response cycle inside the SDK.

    As the name suggests it is not intended to be used by users of the SDK, only actual implementors need to worry about it. Users should look no further than the RequestSpan for passing in a parent span if needed.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void finish()
      Finishes the overall request span (does not touch or change any sub-spans).
      RequestContext requestContext()
      Returns the request context so it can be accessed once set, usually by the tracer implementation.
      void requestContext​(RequestContext ctx)
      Called by the system once the request is created and gives the span a chance to look into request specific information.
      void startDispatch()
      Signals the start of the IO network dispatch phase for this request.
      void startPayloadEncoding()
      Signals the start of payload encoding, if needed for this request.
      void stopDispatch()
      Signals the end of the IO network dispatch phase for this request.
      void stopPayloadEncoding()
      Signals the end of payload encoding, if needed for this request.
      RequestSpan toRequestSpan()
      Returns a request span that wraps the internal span.
    • Method Detail

      • finish

        void finish()
        Finishes the overall request span (does not touch or change any sub-spans).
      • requestContext

        void requestContext​(RequestContext ctx)
        Called by the system once the request is created and gives the span a chance to look into request specific information.
        Parameters:
        ctx - the request context once available.
      • requestContext

        RequestContext requestContext()
        Returns the request context so it can be accessed once set, usually by the tracer implementation.
      • startPayloadEncoding

        void startPayloadEncoding()
        Signals the start of payload encoding, if needed for this request.
      • stopPayloadEncoding

        void stopPayloadEncoding()
        Signals the end of payload encoding, if needed for this request.
      • startDispatch

        void startDispatch()
        Signals the start of the IO network dispatch phase for this request.
      • stopDispatch

        void stopDispatch()
        Signals the end of the IO network dispatch phase for this request.
      • toRequestSpan

        RequestSpan toRequestSpan()
        Returns a request span that wraps the internal span.