Package io.micrometer.observation.contextpropagation

Class ObservationThreadLocalAccessor

java.lang.Object

io.micrometer.observation.contextpropagation.ObservationThreadLocalAccessor

All Implemented Interfaces:

io.micrometer.context.ThreadLocalAccessor<Observation>

public class ObservationThreadLocalAccessor
extends Object
implements io.micrometer.context.ThreadLocalAccessor<Observation>

A ThreadLocalAccessor to put and restore current Observation.

Since:

1.10.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	KEY	Key under which Micrometer Observation is being registered.

Constructor Summary

Constructors

Constructor	Description
ObservationThreadLocalAccessor()	Creates a new instance of this class and stores a static handle to it.
ObservationThreadLocalAccessor(ObservationRegistry observationRegistry)	Creates a new instance of this class.

Method Summary

Modifier and Type	Method	Description
static ObservationThreadLocalAccessor	getInstance()	Return the singleton instance of this ObservationThreadLocalAccessor.
ObservationRegistry	getObservationRegistry()	Returns the provided ObservationRegistry.
Observation	getValue()
Object	key()
void	reset()	Deprecated.
void	restore()
void	restore(Observation value)
void	setObservationRegistry(ObservationRegistry observationRegistry)	Provide an ObservationRegistry to be used by ObservationThreadLocalAccessor.
void	setValue()
void	setValue(Observation value)

Methods inherited from class java.lang.Object

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

Field Details

KEY

public static final String KEY

Key under which Micrometer Observation is being registered.

See Also:

• Constant Field Values

Constructor Details

ObservationThreadLocalAccessor

public ObservationThreadLocalAccessor()

Creates a new instance of this class and stores a static handle to it. Remember to call ContextRegistry.getInstance() to load all accessors which will call this constructor.

ObservationThreadLocalAccessor

public ObservationThreadLocalAccessor(ObservationRegistry observationRegistry)

Creates a new instance of this class.

Parameters:

observationRegistry - observation registry

Since:

1.10.8

Method Details

setObservationRegistry

public void setObservationRegistry(ObservationRegistry observationRegistry)

Provide an ObservationRegistry to be used by ObservationThreadLocalAccessor.

Parameters:

observationRegistry - observation registry

Since:

1.10.8

getObservationRegistry

public ObservationRegistry getObservationRegistry()

Returns the provided ObservationRegistry.

Returns:

observation registry

Since:

1.10.8

getInstance

public static ObservationThreadLocalAccessor getInstance()

Return the singleton instance of this ObservationThreadLocalAccessor.

Returns:

instance

Since:

1.10.8

key

public Object key()

Specified by:

key in interface io.micrometer.context.ThreadLocalAccessor<Observation>

getValue

public Observation getValue()

Specified by:

getValue in interface io.micrometer.context.ThreadLocalAccessor<Observation>

setValue

public void setValue(Observation value)

Specified by:

setValue in interface io.micrometer.context.ThreadLocalAccessor<Observation>

setValue

public void setValue()

Specified by:

setValue in interface io.micrometer.context.ThreadLocalAccessor<Observation>

restore

public void restore()

Specified by:

restore in interface io.micrometer.context.ThreadLocalAccessor<Observation>

restore

public void restore(Observation value)

Specified by:

restore in interface io.micrometer.context.ThreadLocalAccessor<Observation>

reset

@Deprecated
public void reset()

Deprecated.

Specified by:

reset in interface io.micrometer.context.ThreadLocalAccessor<Observation>