Class SearchRequest

java.lang.Object
codes.grow.packages.tempo.SearchRequest

public final class SearchRequest extends Object
Request of TempoQueryClient.search(SearchRequest): a TraceQL query plus window and limits.

 SearchRequest req = SearchRequest.builder()
     .traceql(TraceQL.span(Map.of("resource.service.name", "api")))
     .limit(5)
     .spss(10)
     .build();
 
  • Method Details

    • builder

      public static SearchRequest.Builder builder()
      Starts a builder.
      Returns:
      builder
    • of

      public static SearchRequest of(String traceql)
      Request for one TraceQL query with Tempo's defaults.
      Parameters:
      traceql - TraceQL text
      Returns:
      request
    • traceql

      public Optional<String> traceql()
      TraceQL query, trimmed. Empty when unset or blank: the search then sends no q and Tempo matches every trace (same in every language).
      Returns:
      query text, if set
    • start

      public Optional<Instant> start()
      Window start.
      Returns:
      start, if set
    • end

      public Optional<Instant> end()
      Window end.
      Returns:
      end, if set
    • limit

      public OptionalInt limit()
      Maximum number of traces (Tempo default 20).
      Returns:
      limit, if set
    • spss

      public OptionalInt spss()
      Maximum spans per spanset (Tempo default 3).
      Returns:
      spss, if set