Class InProcessSampledSpanStoreImpl

java.lang.Object

io.opencensus.trace.export.SampledSpanStore

io.opencensus.implcore.trace.export.SampledSpanStoreImpl

io.opencensus.implcore.trace.export.InProcessSampledSpanStoreImpl

@ThreadSafe
public final class InProcessSampledSpanStoreImpl
extends SampledSpanStoreImpl

In-process implementation of the SampledSpanStore.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	InProcessSampledSpanStoreImpl.Bucket
private static final class	InProcessSampledSpanStoreImpl.PerSpanNameSamples	Keeps samples for a given span name.
private static final class	InProcessSampledSpanStoreImpl.RegisterSpanNameEvent
private static final class	InProcessSampledSpanStoreImpl.UnregisterSpanNameEvent

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 final EventQueue	eventQueue
private static final int	MAX_PER_SPAN_NAME_SAMPLES
private static final int	NUM_ERROR_BUCKETS
private static final int	NUM_LATENCY_BUCKETS
private static final int	NUM_SAMPLES_PER_ERROR_BUCKET
private static final int	NUM_SAMPLES_PER_LATENCY_BUCKET
private final Map<String, InProcessSampledSpanStoreImpl.PerSpanNameSamples>	samples
private static final long	TIME_BETWEEN_SAMPLES

Constructor Summary

Constructors

Constructor	Description
InProcessSampledSpanStoreImpl(EventQueue eventQueue)	Constructs a new InProcessSampledSpanStoreImpl.

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.
private void	internaltRegisterSpanNamesForCollection(Collection<String> spanNames)
private void	internalUnregisterSpanNamesForCollection(Collection<String> spanNames)
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.
protected void	shutdown()
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

Methods inherited from class Object

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

Field Details

NUM_SAMPLES_PER_LATENCY_BUCKET

private static final int NUM_SAMPLES_PER_LATENCY_BUCKET

See Also:

• Constant Field Values

NUM_SAMPLES_PER_ERROR_BUCKET

private static final int NUM_SAMPLES_PER_ERROR_BUCKET

See Also:

• Constant Field Values

TIME_BETWEEN_SAMPLES

private static final long TIME_BETWEEN_SAMPLES

NUM_LATENCY_BUCKETS

private static final int NUM_LATENCY_BUCKETS

NUM_ERROR_BUCKETS

private static final int NUM_ERROR_BUCKETS

MAX_PER_SPAN_NAME_SAMPLES

private static final int MAX_PER_SPAN_NAME_SAMPLES

eventQueue

private final EventQueue eventQueue

samples

private final Map<String, InProcessSampledSpanStoreImpl.PerSpanNameSamples> samples

Constructor Details

InProcessSampledSpanStoreImpl

InProcessSampledSpanStoreImpl(EventQueue eventQueue)

Constructs a new InProcessSampledSpanStoreImpl.

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.

shutdown

protected void shutdown()

Overrides:

shutdown in class SampledSpanStoreImpl

internaltRegisterSpanNamesForCollection

private void internaltRegisterSpanNamesForCollection(Collection<String> spanNames)

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.

internalUnregisterSpanNamesForCollection

private void internalUnregisterSpanNamesForCollection(Collection<String> spanNames)

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.