io.opencensus.trace.export

Class SampledSpanStore.ErrorFilter

java.lang.Object

io.opencensus.trace.export.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.

Method Summary

Modifier and Type	Method and Description
static SampledSpanStore.ErrorFilter	create(String spanName, Status.CanonicalCode canonicalCode, int maxSpansToReturn) Returns a new instance of ErrorFilter.
abstract Status.CanonicalCode	getCanonicalCode() Returns the canonical code used by this filter.
abstract int	getMaxSpansToReturn() Returns the maximum number of spans to be returned.
abstract String	getSpanName() Returns the span name used by this filter.

Methods inherited from class java.lang.Object

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

Method Detail

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.

getSpanName

public abstract String getSpanName()

Returns the span name used by this filter.

Returns:

the span name used by this filter.

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.

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.