A ThreadLocalAccessor to put and restore current Span depending on whether ObservationThreadLocalAccessor did some work or not (if ObservationThreadLocalAccessor opened a scope, then this class doesn't want to create yet another span).

In essence logic of this class is as follows:

If ObservationThreadLocalAccessor created a Span via the TracingObservationHandler - do nothing
else - take care of the creation of a Span and putting it in thread local

Important Note

ObservationAwareSpanThreadLocalAccessor must be registered AFTER the ObservationThreadLocalAccessor. The easiest way to achieve that is to call ContextRegistry#registerThreadLocalAccessor(ThreadLocalAccessor) manually.

Modifier and Type	Class and Description
pack-priv static class	ObservationAwareSpanThreadLocalAccessor.SpanAction

Field Summary

Modifier and Type	Field and Description
public static final String	KEY Key under which Micrometer Tracing is being registered.
private static final InternalLogger	log
private final ObservationRegistry	registry
pack-priv final Map<Thread, ObservationAwareSpanThreadLocalAccessor.SpanAction>	spanActions
private final Tracer	tracer

Constructor Summary

Access	Constructor and Description
public	ObservationAwareSpanThreadLocalAccessor(Tracer tracer tracer) Creates a new instance of `ObservationThreadLocalAccessor`.
public	ObservationAwareSpanThreadLocalAccessor(ObservationRegistry observationRegistry observationRegistry, Tracer tracer tracer) Creates a new instance of `ObservationThreadLocalAccessor`.

Method Summary

Modifier and Type	Method and Description
public Span	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	restore(Span previous value to set, never `null` when called from a `ContextSnapshot` * implementation, which is not allowed to store mappings to `null`. previousValue) Overrides default io.micrometer.context.ThreadLocalAccessor.restore. Restore the `ThreadLocal` at the end of a `io.`
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	setValue(Span 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

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

log	back to summary
private static final InternalLogger log

registry	back to summary
private final ObservationRegistry registry

spanActions	back to summary
pack-priv final Map<Thread, ObservationAwareSpanThreadLocalAccessor.SpanAction> spanActions

tracer	back to summary
private final Tracer tracer

Constructor Detail

ObservationAwareSpanThreadLocalAccessor back to summary

ObservationAwareSpanThreadLocalAccessor	back to summary
public ObservationAwareSpanThreadLocalAccessor(Tracer tracer) Creates a new instance of `ObservationThreadLocalAccessor`. Parameters tracer:Tracer tracer

public ObservationAwareSpanThreadLocalAccessor(Tracer tracer)

Creates a new instance of ObservationThreadLocalAccessor.

Parameters

tracer:Tracer: tracer

ObservationAwareSpanThreadLocalAccessor back to summary

ObservationAwareSpanThreadLocalAccessor	back to summary
public ObservationAwareSpanThreadLocalAccessor(ObservationRegistry observationRegistry, Tracer tracer) Creates a new instance of `ObservationThreadLocalAccessor`. Parameters observationRegistry:ObservationRegistry observationRegistry tracer:Tracer tracer

public ObservationAwareSpanThreadLocalAccessor(ObservationRegistry observationRegistry, Tracer tracer)

Creates a new instance of ObservationThreadLocalAccessor.

Parameters

observationRegistry:ObservationRegistry: observationRegistry
tracer:Tracer: tracer

Method Detail

getValue back to summary

getValue	back to summary
public Span 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 Span 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

restore back to summary

restore	back to summary
public void restore(Span previousValue) 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 previousValue:Span 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(Span previousValue)

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

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

Annotations

@Override

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

setValue back to summary

setValue	back to summary
public void setValue(Span 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:Span 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(Span 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:Span: 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

io.micrometer.tracing.contextpropagation back to summary

pack-priv Class ObservationAwareSpanThreadLocalAccessor.SpanAction

Class Inheritance

extends Object
implements AutoCloseable

java.lang.Object
io.micrometer.tracing.contextpropagation.ObservationAwareSpanThreadLocalAccessor.SpanAction

All Implemented Interfaces

java.lang.AutoCloseable

Field Summary

Modifier and Type	Field and Description
pack-priv final ObservationAwareSpanThreadLocalAccessor.SpanAction	previous
pack-priv AutoCloseable	scope
pack-priv final Map<Thread, ObservationAwareSpanThreadLocalAccessor.SpanAction>	todo

Constructor Summary

Access	Constructor and Description
pack-priv	SpanAction(Map<Thread, ObservationAwareSpanThreadLocalAccessor.SpanAction> spanActions, ObservationAwareSpanThreadLocalAccessor.SpanAction previous)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources.
pack-priv void	setScope(Closeable scope)

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

Field Detail

previous	back to summary
pack-priv final ObservationAwareSpanThreadLocalAccessor.SpanAction previous

scope	back to summary
pack-priv AutoCloseable scope

todo	back to summary
pack-priv final Map<Thread, ObservationAwareSpanThreadLocalAccessor.SpanAction> todo

Constructor Detail

SpanAction	back to summary
pack-priv SpanAction(Map<Thread, ObservationAwareSpanThreadLocalAccessor.SpanAction> spanActions, ObservationAwareSpanThreadLocalAccessor.SpanAction previous)

Method Detail

close back to summary

close	back to summary
public void close() Implements java.lang.AutoCloseable.close. Doc from java.lang.AutoCloseable.close. Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the `try`-with-resources statement. Annotations @Override

public void close()

Implements java.lang.AutoCloseable.close.

Doc from java.lang.AutoCloseable.close.

Closes this resource, relinquishing any underlying resources. This method is invoked automatically on objects managed by the try-with-resources statement.

Annotations

@Override

setScope	back to summary
pack-priv void setScope(Closeable scope)

public Class ObservationAwareSpanThreadLocalAccessor

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

pack-priv Class ObservationAwareSpanThreadLocalAccessor.SpanAction

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail