io.opencensus.trace.export

Class SampledSpanStore.LatencyFilter

java.lang.Object

io.opencensus.trace.export.SampledSpanStore.LatencyFilter

Enclosing class:

SampledSpanStore

@Immutable
public abstract static class SampledSpanStore.LatencyFilter
extends Object

Filter for latency based sampled spans. Used to filter results returned by the SampledSpanStore.getLatencySampledSpans(LatencyFilter) request.

Since:

0.5

Method Summary

Modifier and Type	Method and Description
static SampledSpanStore.LatencyFilter	create(String spanName, long latencyLowerNs, long latencyUpperNs, int maxSpansToReturn) Returns a new instance of LatencyFilter.
abstract long	getLatencyLowerNs() Returns the latency lower bound of this bucket (inclusive).
abstract long	getLatencyUpperNs() Returns the latency upper bound of this bucket (exclusive).
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.LatencyFilter create(String spanName,
                                                    long latencyLowerNs,
                                                    long latencyUpperNs,
                                                    int maxSpansToReturn)

Returns a new instance of LatencyFilter.

Filters all the spans based on spanName and latency in the interval [latencyLowerNs, latencyUpperNs) and returns a maximum of maxSpansToReturn.

Parameters:

spanName - the name of the span.

latencyLowerNs - the latency lower bound.

latencyUpperNs - the latency upper bound.

maxSpansToReturn - the maximum number of results to be returned. 0 means all.

Returns:

a new instance of LatencyFilter.

Throws:

NullPointerException - if spanName is null.

IllegalArgumentException - if maxSpansToReturn or latencyLowerNs or latencyUpperNs are 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

getLatencyLowerNs

public abstract long getLatencyLowerNs()

Returns the latency lower bound of this bucket (inclusive).

Returns:

the latency lower bound of this bucket.

Since:

0.5

getLatencyUpperNs

public abstract long getLatencyUpperNs()

Returns the latency upper bound of this bucket (exclusive).

Returns:

the latency upper bound of this bucket.

Since:

0.5

getMaxSpansToReturn

public abstract int getMaxSpansToReturn()

Returns the maximum number of spans to be returned. 0 means all.

Returns:

the maximum number of spans to be returned.

Since:

0.5