Package io.opencensus.trace.export
Class SampledSpanStore.LatencyFilter
java.lang.Object
io.opencensus.trace.export.SampledSpanStore.LatencyFilter
- Direct Known Subclasses:
AutoValue_SampledSpanStore_LatencyFilter
- Enclosing class:
SampledSpanStore
Filter for latency based sampled spans. Used to filter results returned by the
SampledSpanStore.getLatencySampledSpans(LatencyFilter)
request.- Since:
- 0.5
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionReturns a new instance ofLatencyFilter
.abstract long
Returns the latency lower bound of this bucket (inclusive).abstract long
Returns the latency upper bound of this bucket (exclusive).abstract int
Returns the maximum number of spans to be returned.abstract String
Returns the span name used by this filter.
-
Constructor Details
-
LatencyFilter
LatencyFilter()
-
-
Method Details
-
create
public static SampledSpanStore.LatencyFilter create(String spanName, long latencyLowerNs, long latencyUpperNs, int maxSpansToReturn) Returns a new instance ofLatencyFilter
.Filters all the spans based on
spanName
and latency in the interval [latencyLowerNs, latencyUpperNs) and returns a maximum ofmaxSpansToReturn
.- 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
- ifspanName
isnull
.IllegalArgumentException
- ifmaxSpansToReturn
orlatencyLowerNs
orlatencyUpperNs
are negative.- Since:
- 0.5
-
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
-