Interface Traces

  • All Known Implementing Classes:
    InMemoryStorage

    public interface Traces
    Allows readback of traces by ID, as written by a SpanConsumer.

    Specifically, this provides apis present when search is disabled.

    Note: This is not considered a user-level Api, rather an Spi that can be used to bind user-level abstractions such as futures or observables.

    Since:
    2.17
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      Call<java.util.List<Span>> getTrace​(java.lang.String traceId)
      Retrieves spans that share a 128-bit trace id with no ordering expectation or empty if none are found.
      Call<java.util.List<java.util.List<Span>>> getTraces​(java.lang.Iterable<java.lang.String> traceIds)
      Retrieves any traces with the specified IDs.
    • Method Detail

      • getTrace

        Call<java.util.List<Span>> getTrace​(java.lang.String traceId)
        Retrieves spans that share a 128-bit trace id with no ordering expectation or empty if none are found.

        When strict trace ID is disabled, spans with the same right-most 16 characters are returned even if the characters to the left are not.

        Implementations should use Span.normalizeTraceId(String) to ensure consistency.

        Parameters:
        traceId - the trace ID
      • getTraces

        Call<java.util.List<java.util.List<Span>>> getTraces​(java.lang.Iterable<java.lang.String> traceIds)
        Retrieves any traces with the specified IDs. Results return in any order, and can be empty.

        When strict trace ID is disabled, spans with the same right-most 16 characters are returned even if the characters to the left are not.

        Implementations should use Span.normalizeTraceId(String) on each input trace ID to ensure consistency.

        Parameters:
        traceIds - a list of unique trace IDs.
        Returns:
        traces matching the supplied trace IDs, in any order