io.opencensus.tags

Class Tags

java.lang.Object

io.opencensus.tags.Tags

public final class Tags
extends Object

Class for accessing the default TagsComponent.

Method Summary

Modifier and Type	Method and Description
static TaggingState	getState() Returns the current TaggingState.
static Tagger	getTagger() Returns the default Tagger.
static TagPropagationComponent	getTagPropagationComponent() Returns the default TagPropagationComponent.
static void	setState(TaggingState 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

getTagger

public static Tagger getTagger()

Returns the default Tagger.

Returns:

the default Tagger.

getTagPropagationComponent

public static TagPropagationComponent getTagPropagationComponent()

Returns the default TagPropagationComponent.

Returns:

the default TagPropagationComponent.

getState

public static TaggingState getState()

Returns the current TaggingState.

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

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

Returns:

the current TaggingState.

setState

@Deprecated
public static void setState(TaggingState 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 TaggingState.

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

Parameters:

state - the new TaggingState.

Throws:

IllegalStateException - if getState() was previously called.