micrometer-observation 1.12.1 · io.micrometer.observation.contextpropagation.ObservationThreadLocalAccessor

Field Summary

Modifier and Type	Field and Description
private static ObservationThreadLocalAccessor	instance
public static final String	KEY Key under which Micrometer Observation is being registered.
private static final InternalLogger	log
private ObservationRegistry	observationRegistry The default implementation of `ObservationRegistry` that Micrometer provides comes with a static `ThreadLocal` instance for accessing the `Observation.`

Constructor Summary

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

Method Summary

Modifier and Type	Method and Description
pack-priv void	assertFalse(String msg)
private void	closeCurrentScope()
public static ObservationThreadLocalAccessor	Returns: instance getInstance() Return the singleton instance of this `ObservationThreadLocalAccessor`.
public ObservationRegistry	Returns: observation registry getObservationRegistry() Returns the provided `ObservationRegistry`.
public Observation	getValue() Implements io.micrometer.context.ThreadLocalAccessor.getValue. Return the current `ThreadLocal` value.
public Object	key() Implements io.micrometer.context.ThreadLocalAccessor.key. The key to associate with the ThreadLocal value when saved within a `ContextSnapshot`.
public void	reset() Overrides default io.micrometer.context.ThreadLocalAccessor.reset. Deprecated Remove the `ThreadLocal` value when setting `ThreadLocal` values in case of missing mapping for a `key()` from a `ContextSnapshot`, or a Context object (operated upon by `ContextAccessor`).
public void	restore() Overrides default io.micrometer.context.ThreadLocalAccessor.restore. Called instead of `restore(Object)` when there was no `ThreadLocal` value existing at the start of the scope.
public void	restore(Observation previous value to set, never `null` when called from a `ContextSnapshot` * implementation, which is not allowed to store mappings to `null`. value) Overrides default io.micrometer.context.ThreadLocalAccessor.restore. Restore the `ThreadLocal` at the end of a `io.`
public void	setObservationRegistry(ObservationRegistry observation registry observationRegistry) Provide an `ObservationRegistry` to be used by `ObservationThreadLocalAccessor`.
public void	setValue(Observation the value to set, never `null` when called from a `ContextSnapshot` implementation, which is not allowed to store mappings to `null`. value) Implements io.micrometer.context.ThreadLocalAccessor.setValue. Set the `ThreadLocal` at the start of a `io.`
public void	setValue() Overrides default io.micrometer.context.ThreadLocalAccessor.setValue. Called instead of `setValue(Object)` in order to remove the current `ThreadLocal` value at the start of a `io.`

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

instance	back to summary
private static ObservationThreadLocalAccessor instance

KEY	back to summary
public static final String KEY Key under which Micrometer Observation is being registered.

log	back to summary
private static final InternalLogger log

observationRegistry back to summary

observationRegistry	back to summary
private ObservationRegistry observationRegistry The default implementation of `ObservationRegistry` that Micrometer provides comes with a static `ThreadLocal` instance for accessing the `Observation.Scope`. That's why we can create an instance of the default implementation of the registry just to call its `ObservationRegistry#getCurrentObservation()` because that in turn will look at the static ThreadLocal and will always return the proper scope.

private ObservationRegistry observationRegistry

The default implementation of ObservationRegistry that Micrometer provides comes with a static ThreadLocal instance for accessing the Observation.Scope. That's why we can create an instance of the default implementation of the registry just to call its ObservationRegistry#getCurrentObservation() because that in turn will look at the static ThreadLocal and will always return the proper scope.

Constructor Detail

ObservationThreadLocalAccessor	back to summary
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	back to summary
public ObservationThreadLocalAccessor(ObservationRegistry observationRegistry) Creates a new instance of this class. Parameters observationRegistry:ObservationRegistry observation registry Since 1.10.8

ObservationThreadLocalAccessor

back to summary

public ObservationThreadLocalAccessor(ObservationRegistry observationRegistry)

Creates a new instance of this class.

Parameters

observationRegistry:ObservationRegistry: observation registry

Since

1.10.8

Method Detail

assertFalse	back to summary
pack-priv void assertFalse(String msg)

closeCurrentScope	back to summary
private void closeCurrentScope()

getInstance back to summary

getInstance	back to summary
public static ObservationThreadLocalAccessor getInstance() Return the singleton instance of this `ObservationThreadLocalAccessor`. Returns:ObservationThreadLocalAccessor instance Since 1.10.8

public static ObservationThreadLocalAccessor getInstance()

Return the singleton instance of this ObservationThreadLocalAccessor.

Returns:ObservationThreadLocalAccessor: instance
Since: 1.10.8

getObservationRegistry back to summary

getObservationRegistry	back to summary
public ObservationRegistry getObservationRegistry() Returns the provided `ObservationRegistry`. Returns:ObservationRegistry observation registry Since 1.10.8

public ObservationRegistry getObservationRegistry()

Returns the provided ObservationRegistry.

Returns:ObservationRegistry: observation registry
Since: 1.10.8

getValue back to summary

getValue	back to summary
public Observation getValue() Implements io.micrometer.context.ThreadLocalAccessor.getValue. Doc from io.micrometer.context.ThreadLocalAccessor.getValue. Return the current `ThreadLocal` value. This method is called in two scenarios: When capturing a `ContextSnapshot`. A `null` value is ignored and the `key()` will not be present in the snapshot. When setting `ThreadLocal` values from a `ContextSnapshot` or from a Context object (through a `ContextAccessor`) to save existing values in order to `restore(Object)` them at the end of the scope. A `null` value means the `ThreadLocal` should not be set and upon closing a `io.micrometer.context.ContextSnapshot.Scope`, the `restore()` variant is called. Annotations @Override

public Observation getValue()

Implements io.micrometer.context.ThreadLocalAccessor.getValue.

Doc from io.micrometer.context.ThreadLocalAccessor.getValue.

Return the current ThreadLocal value.

This method is called in two scenarios:

When capturing a ContextSnapshot. A null value is ignored and the key() will not be present in the snapshot.
When setting ThreadLocal values from a ContextSnapshot or from a Context object (through a ContextAccessor) to save existing values in order to restore(Object) them at the end of the scope. A null value means the ThreadLocal should not be set and upon closing a io.micrometer.context.ContextSnapshot.Scope, the restore() variant is called.

Annotations

@Override

key back to summary

key	back to summary
public Object key() Implements io.micrometer.context.ThreadLocalAccessor.key. Doc from io.micrometer.context.ThreadLocalAccessor.key. The key to associate with the ThreadLocal value when saved within a `ContextSnapshot`. Annotations @Override

public Object key()

Implements io.micrometer.context.ThreadLocalAccessor.key.

Doc from io.micrometer.context.ThreadLocalAccessor.key.

The key to associate with the ThreadLocal value when saved within a ContextSnapshot.

Annotations

@Override

reset back to summary

reset	back to summary
public void reset() Overrides default io.micrometer.context.ThreadLocalAccessor.reset. Doc from io.micrometer.context.ThreadLocalAccessor.reset. Deprecated Remove the `ThreadLocal` value when setting `ThreadLocal` values in case of missing mapping for a `key()` from a `ContextSnapshot`, or a Context object (operated upon by `ContextAccessor`). Annotations @Override @Deprecated

public void reset()

Overrides default io.micrometer.context.ThreadLocalAccessor.reset.

Doc from io.micrometer.context.ThreadLocalAccessor.reset.

Deprecated

Remove the ThreadLocal value when setting ThreadLocal values in case of missing mapping for a key() from a ContextSnapshot, or a Context object (operated upon by ContextAccessor).

Annotations

@Override
@Deprecated

restore back to summary

restore	back to summary
public void restore() Overrides default io.micrometer.context.ThreadLocalAccessor.restore. Doc from io.micrometer.context.ThreadLocalAccessor.restore. Called instead of `restore(Object)` when there was no `ThreadLocal` value existing at the start of the scope. Annotations @Override

public void restore()

Overrides default io.micrometer.context.ThreadLocalAccessor.restore.

Doc from io.micrometer.context.ThreadLocalAccessor.restore.

Called instead of restore(Object) when there was no ThreadLocal value existing at the start of the scope.

Annotations

@Override

restore back to summary

restore	back to summary
public void restore(Observation value) Overrides default io.micrometer.context.ThreadLocalAccessor.restore. Doc from io.micrometer.context.ThreadLocalAccessor.restore. Restore the `ThreadLocal` at the end of a `io.micrometer.context.ContextSnapshot.Scope` to the previous value it had before the start of the scope. Parameters value:Observation previous value to set, never `null` when called from a `ContextSnapshot` * implementation, which is not allowed to store mappings to `null`. Annotations @Override

public void restore(Observation value)

Overrides default io.micrometer.context.ThreadLocalAccessor.restore.

Doc from io.micrometer.context.ThreadLocalAccessor.restore.

Restore the ThreadLocal at the end of a io.micrometer.context.ContextSnapshot.Scope to the previous value it had before the start of the scope.

Parameters

value:Observation: previous value to set, never null when called from a ContextSnapshot * implementation, which is not allowed to store mappings to null.

Annotations

@Override

setObservationRegistry back to summary

setObservationRegistry	back to summary
public void setObservationRegistry(ObservationRegistry observationRegistry) Provide an `ObservationRegistry` to be used by `ObservationThreadLocalAccessor`. Parameters observationRegistry:ObservationRegistry observation registry Since 1.10.8

public void setObservationRegistry(ObservationRegistry observationRegistry)

Provide an ObservationRegistry to be used by ObservationThreadLocalAccessor.

Parameters

observationRegistry:ObservationRegistry: observation registry

Since

1.10.8

setValue back to summary

setValue	back to summary
public void setValue(Observation value) Implements io.micrometer.context.ThreadLocalAccessor.setValue. Doc from io.micrometer.context.ThreadLocalAccessor.setValue. Set the `ThreadLocal` at the start of a `io.micrometer.context.ContextSnapshot.Scope` to a value obtained from a `ContextSnapshot` or from a different type of context (through a `ContextAccessor`). Parameters value:Observation the value to set, never `null` when called from a `ContextSnapshot` implementation, which is not allowed to store mappings to `null`. Annotations @Override

public void setValue(Observation value)

Implements io.micrometer.context.ThreadLocalAccessor.setValue.

Doc from io.micrometer.context.ThreadLocalAccessor.setValue.

Set the ThreadLocal at the start of a io.micrometer.context.ContextSnapshot.Scope to a value obtained from a ContextSnapshot or from a different type of context (through a ContextAccessor).

Parameters

value:Observation: the value to set, never null when called from a ContextSnapshot implementation, which is not allowed to store mappings to null.

Annotations

@Override

setValue back to summary

setValue	back to summary
public void setValue() Overrides default io.micrometer.context.ThreadLocalAccessor.setValue. Doc from io.micrometer.context.ThreadLocalAccessor.setValue. Called instead of `setValue(Object)` in order to remove the current `ThreadLocal` value at the start of a `io.micrometer.context.ContextSnapshot.Scope`. Annotations @Override

public void setValue()

Overrides default io.micrometer.context.ThreadLocalAccessor.setValue.

Doc from io.micrometer.context.ThreadLocalAccessor.setValue.

Called instead of setValue(Object) in order to remove the current ThreadLocal value at the start of a io.micrometer.context.ContextSnapshot.Scope.

Annotations

@Override

public Class ObservationThreadLocalAccessor

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail