io.opencensus.stats

Class Stats

java.lang.Object

io.opencensus.stats.Stats

public final class Stats
extends Object

Class for accessing the default StatsComponent.

Method Summary

Modifier and Type	Method and Description
static StatsCollectionState	getState() Returns the current StatsCollectionState.
static StatsRecorder	getStatsRecorder() Returns the default StatsRecorder.
static ViewManager	getViewManager() Returns the default ViewManager.
static void	setState(StatsCollectionState state) Deprecated. This method is deprecated because other libraries could cache the result of getState(), use a stale value, and behave incorrectly. It is only safe to call early in initialization. This method throws IllegalStateException after getState() has been called, in order to limit changes to the result of getState().

Methods inherited from class java.lang.Object

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

Method Detail

getStatsRecorder

public static StatsRecorder getStatsRecorder()

Returns the default StatsRecorder.

getViewManager

public static ViewManager getViewManager()

Returns the default ViewManager.

getState

public static StatsCollectionState getState()

Returns the current StatsCollectionState.

When no implementation is available, getState always returns StatsCollectionState.DISABLED.

Once getState() is called, subsequent calls to setState(StatsCollectionState) will throw an IllegalStateException.

Returns:

the current StatsCollectionState.

setState

@Deprecated
public static void setState(StatsCollectionState state)

Deprecated. This method is deprecated because other libraries could cache the result of getState(), use a stale value, and behave incorrectly. It is only safe to call early in initialization. This method throws IllegalStateException after getState() has been called, in order to limit changes to the result of getState().

Sets the current StatsCollectionState.

When no implementation is available, setState does not change the state.

If state is set to StatsCollectionState.DISABLED, all stats that are previously recorded will be cleared.

Parameters:

state - the new StatsCollectionState.

Throws:

IllegalStateException - if getState() was previously called.