Class SampledSpanStoreImpl.NoopSampledSpanStoreImpl

java.lang.Object

io.opencensus.trace.export.SampledSpanStore

io.opencensus.implcore.trace.export.SampledSpanStoreImpl

io.opencensus.implcore.trace.export.SampledSpanStoreImpl.NoopSampledSpanStoreImpl

Enclosing class:

SampledSpanStoreImpl

private static final class SampledSpanStoreImpl.NoopSampledSpanStoreImpl
extends SampledSpanStoreImpl

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 Set<String>	EMPTY_REGISTERED_SPAN_NAMES
private static final Collection<SpanData>	EMPTY_SPANDATA
private static final SampledSpanStore.Summary	EMPTY_SUMMARY

Constructor Summary

Constructors

Modifier	Constructor	Description
private	NoopSampledSpanStoreImpl()

Method Summary

Modifier and Type	Method	Description
void	considerForSampling(RecordEventsSpanImpl span)	Considers to save the given spans to the stored samples.
boolean	getEnabled()	Returns true if the SampledSpanStore is enabled.
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 SampledSpanStoreImpl

getNoopSampledSpanStoreImpl, shutdown

Methods inherited from class Object

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

Field Details

EMPTY_SUMMARY

private static final SampledSpanStore.Summary EMPTY_SUMMARY

EMPTY_REGISTERED_SPAN_NAMES

private static final Set<String> EMPTY_REGISTERED_SPAN_NAMES

EMPTY_SPANDATA

private static final Collection<SpanData> EMPTY_SPANDATA

Constructor Details

NoopSampledSpanStoreImpl

private NoopSampledSpanStoreImpl()

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.

considerForSampling

public void considerForSampling(RecordEventsSpanImpl span)

Description copied from class: SampledSpanStoreImpl

Considers to save the given spans to the stored samples. This must be called at the end of each Span with the option RECORD_EVENTS.

Specified by:

considerForSampling in class SampledSpanStoreImpl

Parameters:

span - the span to be consider for storing into the store buckets.

getEnabled

public boolean getEnabled()

Description copied from class: SampledSpanStoreImpl

Returns true if the SampledSpanStore is enabled.

Specified by:

getEnabled in class SampledSpanStoreImpl

Returns:

true if the SampledSpanStore is enabled.

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.

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.

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.