Class SampledSpanStore.NoopSampledSpanStore

java.lang.Object

io.opencensus.trace.export.SampledSpanStore

io.opencensus.trace.export.SampledSpanStore.NoopSampledSpanStore

Enclosing class:

SampledSpanStore

@ThreadSafe
private static final class SampledSpanStore.NoopSampledSpanStore
extends SampledSpanStore

Since:

0.5

Nested Class Summary

Nested classes/interfaces inherited from class SampledSpanStore

SampledSpanStore.ErrorFilter, SampledSpanStore.LatencyBucketBoundaries, SampledSpanStore.LatencyFilter, SampledSpanStore.PerSpanNameSummary, SampledSpanStore.Summary

Field Summary

Fields

Modifier and Type	Field	Description
private static final SampledSpanStore.PerSpanNameSummary	EMPTY_PER_SPAN_NAME_SUMMARY
private final Set<String>	registeredSpanNames

Constructor Summary

Constructors

Modifier	Constructor	Description
private	NoopSampledSpanStore()

Method Summary

Modifier and Type	Method	Description
Collection<SpanData>	getErrorSampledSpans(SampledSpanStore.ErrorFilter filter)	Returns a list of failed spans (spans with Status other than Status.OK) that match the filter.
Collection<SpanData>	getLatencySampledSpans(SampledSpanStore.LatencyFilter filter)	Returns a list of succeeded spans (spans with Status equal to Status.OK) that match the filter.
Set<String>	getRegisteredSpanNamesForCollection()	Returns the set of unique span names registered to the library, for use in tests.
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.
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.
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 SampledSpanStore

newNoopSampledSpanStore

Methods inherited from class Object

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

Field Details

EMPTY_PER_SPAN_NAME_SUMMARY

private static final SampledSpanStore.PerSpanNameSummary EMPTY_PER_SPAN_NAME_SUMMARY

registeredSpanNames

private final Set<String> registeredSpanNames

Constructor Details

NoopSampledSpanStore

private NoopSampledSpanStore()

Method Details

getSummary

public SampledSpanStore.Summary getSummary()

Description copied from class: SampledSpanStore

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 SampledSpanStore.registerSpanNamesForCollection(Collection).

Specified by:

getSummary in class SampledSpanStore

Returns:

the summary of all available data.

getLatencySampledSpans

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

Description copied from class: SampledSpanStore

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 SampledSpanStore.registerSpanNamesForCollection(Collection).

Specified by:

getLatencySampledSpans in class SampledSpanStore

Parameters:

filter - used to filter the returned sampled spans.

Returns:

a list of succeeded spans that match the filter.

getErrorSampledSpans

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

Description copied from class: SampledSpanStore

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 SampledSpanStore.registerSpanNamesForCollection(Collection).

Specified by:

getErrorSampledSpans in class SampledSpanStore

Parameters:

filter - used to filter the returned sampled spans.

Returns:

a list of failed spans that match the filter.

registerSpanNamesForCollection

public void registerSpanNamesForCollection(Collection<String> spanNames)

Description copied from class: SampledSpanStore

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.

Specified by:

registerSpanNamesForCollection in class SampledSpanStore

Parameters:

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

unregisterSpanNamesForCollection

public void unregisterSpanNamesForCollection(Collection<String> spanNames)

Description copied from class: SampledSpanStore

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.

Specified by:

unregisterSpanNamesForCollection in class SampledSpanStore

Parameters:

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

getRegisteredSpanNamesForCollection

public Set<String> getRegisteredSpanNamesForCollection()

Description copied from class: SampledSpanStore

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

This method is only meant for testing code that uses OpenCensus, and it is not performant.

Specified by:

getRegisteredSpanNamesForCollection in class SampledSpanStore

Returns:

the set of unique span names registered to the library.