Class SampledSpanStore.ErrorFilter

java.lang.Object
io.opencensus.trace.export.SampledSpanStore.ErrorFilter
Direct Known Subclasses:
AutoValue_SampledSpanStore_ErrorFilter
Enclosing class:
SampledSpanStore

@Immutable public abstract static class SampledSpanStore.ErrorFilter extends Object
Filter for error based sampled spans. Used to filter results returned by the SampledSpanStore.getErrorSampledSpans(ErrorFilter) request.
Since:
0.5
  • Constructor Details

    • ErrorFilter

      ErrorFilter()
  • Method Details

    • create

      public static SampledSpanStore.ErrorFilter create(String spanName, @Nullable Status.CanonicalCode canonicalCode, int maxSpansToReturn)
      Returns a new instance of ErrorFilter.

      Filters all the spans based on spanName and canonicalCode and returns a maximum of maxSpansToReturn.

      Parameters:
      spanName - the name of the span.
      canonicalCode - the error code of the span. null can be used to query all error codes.
      maxSpansToReturn - the maximum number of results to be returned. 0 means all.
      Returns:
      a new instance of ErrorFilter.
      Throws:
      NullPointerException - if spanName is null.
      IllegalArgumentException - if canonicalCode is Status.CanonicalCode.OK or maxSpansToReturn is negative.
      Since:
      0.5
    • getSpanName

      public abstract String getSpanName()
      Returns the span name used by this filter.
      Returns:
      the span name used by this filter.
      Since:
      0.5
    • getCanonicalCode

      @Nullable public abstract Status.CanonicalCode getCanonicalCode()
      Returns the canonical code used by this filter. Always different than Status.CanonicalCode.OK. If null then all errors match.
      Returns:
      the canonical code used by this filter.
      Since:
      0.5
    • getMaxSpansToReturn

      public abstract int getMaxSpansToReturn()
      Returns the maximum number of spans to be returned. Used to enforce the number of returned SpanData. 0 means all.
      Returns:
      the maximum number of spans to be returned.
      Since:
      0.5