io.opencensus.trace.export

Class SampledSpanStore

java.lang.Object

io.opencensus.trace.export.SampledSpanStore

@ThreadSafe
public abstract class SampledSpanStore
extends Object

This class allows users to access in-process information such as latency based sampled spans and error based sampled spans.

For all completed spans with the option Span.Options#RECORD_EVENTS the library can store samples based on latency for succeeded operations or based on error code for failed operations. To activate this, users MUST manually configure all the span names for which samples will be collected (see registerSpanNamesForCollection(Collection)).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SampledSpanStore.ErrorFilter Filter for error based sampled spans.
static class	SampledSpanStore.LatencyBucketBoundaries The latency buckets boundaries.
static class	SampledSpanStore.LatencyFilter Filter for latency based sampled spans.
static class	SampledSpanStore.PerSpanNameSummary Summary of all available data for a span name.
static class	SampledSpanStore.Summary The summary of all available data.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	SampledSpanStore()

Method Summary

Modifier and Type	Method and Description
abstract Collection<SpanData>	getErrorSampledSpans(SampledSpanStore.ErrorFilter filter) Returns a list of failed spans (spans with Status other than Status.OK) that match the filter.
abstract Collection<SpanData>	getLatencySampledSpans(SampledSpanStore.LatencyFilter filter) Returns a list of succeeded spans (spans with Status equal to Status.OK) that match the filter.
abstract Set<String>	getRegisteredSpanNamesForCollection() Returns the set of unique span names registered to the library.
abstract SampledSpanStore.Summary	getSummary() Returns the summary of all available data, such as number of sampled spans in the latency based samples or error based samples.
abstract void	registerSpanNamesForCollection(Collection<String> spanNames) Appends a list of span names for which the library will collect latency based sampled spans and error based sampled spans.
abstract void	unregisterSpanNamesForCollection(Collection<String> spanNames) Removes a list of span names for which the library will collect latency based sampled spans and error based sampled spans.

Methods inherited from class java.lang.Object

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

Constructor Detail

SampledSpanStore

protected SampledSpanStore()

Method Detail

getSummary

public abstract SampledSpanStore.Summary getSummary()

Returns the summary of all available data, such as number of sampled spans in the latency based samples or error based samples.

Data available only for span names registered using registerSpanNamesForCollection(Collection).

Returns:

the summary of all available data.

getLatencySampledSpans

public abstract Collection<SpanData> getLatencySampledSpans(SampledSpanStore.LatencyFilter filter)

Returns a list of succeeded spans (spans with Status equal to Status.OK) that match the filter.

Latency based sampled spans are available only for span names registered using registerSpanNamesForCollection(Collection).

Parameters:

filter - used to filter the returned sampled spans.

Returns:

a list of succeeded spans that match the filter.

getErrorSampledSpans

public abstract Collection<SpanData> getErrorSampledSpans(SampledSpanStore.ErrorFilter filter)

Returns a list of failed spans (spans with Status other than Status.OK) that match the filter.

Error based sampled spans are available only for span names registered using registerSpanNamesForCollection(Collection).

Parameters:

filter - used to filter the returned sampled spans.

Returns:

a list of failed spans that match the filter.

registerSpanNamesForCollection

public abstract void registerSpanNamesForCollection(Collection<String> spanNames)

Appends a list of span names for which the library will collect latency based sampled spans and error based sampled spans.

If called multiple times the library keeps the list of unique span names from all the calls.

Parameters:

spanNames - list of span names for which the library will collect samples.

unregisterSpanNamesForCollection

public abstract void unregisterSpanNamesForCollection(Collection<String> spanNames)

Removes a list of span names for which the library will collect latency based sampled spans and error based sampled spans.

The library keeps the list of unique registered span names for which samples will be called. This method allows users to remove span names from that list.

Parameters:

spanNames - list of span names for which the library will no longer collect samples.

getRegisteredSpanNamesForCollection

public abstract Set<String> getRegisteredSpanNamesForCollection()

Returns the set of unique span names registered to the library. For this set of span names the library will collect latency based sampled spans and error based sampled spans.

Returns:

the set of unique span names registered to the library.