Class InProcessRunningSpanStore

java.lang.Object

io.opencensus.trace.export.RunningSpanStore

io.opencensus.implcore.trace.export.InProcessRunningSpanStore

@ThreadSafe
public final class InProcessRunningSpanStore
extends RunningSpanStore

In-process implementation of the RunningSpanStore.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	InProcessRunningSpanStore.InProcessRunningSpanStoreImpl

Nested classes/interfaces inherited from class RunningSpanStore

RunningSpanStore.Filter, RunningSpanStore.PerSpanNameSummary, RunningSpanStore.Summary

Field Summary

Fields

Modifier and Type	Field	Description
private static final RunningSpanStore.Summary	EMPTY_SUMMARY
private InProcessRunningSpanStore.InProcessRunningSpanStoreImpl	impl

Constructor Summary

Constructors

Constructor	Description
InProcessRunningSpanStore()

Method Summary

Modifier and Type	Method	Description
(package private) static InProcessRunningSpanStore	create()
boolean	getEnabled()	Returns true if the RunningSpanStore is enabled.
Collection<SpanData>	getRunningSpans(RunningSpanStore.Filter filter)	Returns a list of running spans that match the Filter.
RunningSpanStore.Summary	getSummary()	Returns the summary of all available data such, as number of running spans.
void	onEnd(RecordEventsSpanImpl span)	Removes the Span from the running spans list when the Span ends.
void	onStart(RecordEventsSpanImpl span)	Adds the Span into the running spans list when the Span starts.
void	setMaxNumberOfSpans(int maxNumberOfSpans)	Sets the maximum number of Spans in th RunningSpanStore.

Methods inherited from class Object

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

Field Details

EMPTY_SUMMARY

private static final RunningSpanStore.Summary EMPTY_SUMMARY

impl

@Nullable
private volatile InProcessRunningSpanStore.InProcessRunningSpanStoreImpl impl

Constructor Details

InProcessRunningSpanStore

public InProcessRunningSpanStore()

Method Details

create

static InProcessRunningSpanStore create()

onStart

public void onStart(RecordEventsSpanImpl span)

Adds the Span into the running spans list when the Span starts.

Parameters:

span - the Span that started.

onEnd

public void onEnd(RecordEventsSpanImpl span)

Removes the Span from the running spans list when the Span ends.

Parameters:

span - the Span that ended.

getEnabled

public boolean getEnabled()

Returns true if the RunningSpanStore is enabled.

Returns:

true if the RunningSpanStore is enabled.

getSummary

public RunningSpanStore.Summary getSummary()

Description copied from class: RunningSpanStore

Returns the summary of all available data such, as number of running spans.

Specified by:

getSummary in class RunningSpanStore

Returns:

the summary of all available data.

getRunningSpans

public Collection<SpanData> getRunningSpans(RunningSpanStore.Filter filter)

Description copied from class: RunningSpanStore

Returns a list of running spans that match the Filter.

Specified by:

getRunningSpans in class RunningSpanStore

Parameters:

filter - used to filter the returned spans.

Returns:

a list of running spans that match the Filter.

setMaxNumberOfSpans

public void setMaxNumberOfSpans(int maxNumberOfSpans)

Description copied from class: RunningSpanStore

Sets the maximum number of Spans in th RunningSpanStore.

0 means disabled, by default the RunningSpanStore is disabled.

Specified by:

setMaxNumberOfSpans in class RunningSpanStore

Parameters:

maxNumberOfSpans - the maximum number of Spans in th RunningSpanStore.