micrometer-tracing 1.2.3 · io.micrometer.tracing.contextpropagation.ObservationAwareBaggageThreadLocalAccessor

Modifier and Type	Class and Description
pack-priv static class	ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope

Field Summary

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

Constructor Summary

Access	Constructor and Description
public	ObservationAwareBaggageThreadLocalAccessor(ObservationRegistry observation registry observationRegistry, Tracer tracer tracer) Creates a new instance of this class.

Method Summary

Modifier and Type	Method and Description
private static ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope	baggageScopeClosingScope(Map.Entry<String, String> entry, ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope scope, BaggageInScope baggage)
private void	closeCurrentScope()
private Span	getCurrentSpan(Observation currentObservation)
public BaggageToPropagate	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`.
private ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope	openScopeForEachBaggageEntry(Set<Map.Entry<String, String>> entries, Span span, ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope scope)
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(BaggageToPropagate 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.`
private static ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope	scopeClosingBaggageAndScope(Map.Entry<String, String> entry, BaggageInScope baggage)
private ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope	scopeRestoringBaggageAndScope(ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope currentScope, ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope previousScope)
public void	setValue(BaggageToPropagate 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

baggageInScope	back to summary
pack-priv final Map<Thread, ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope> baggageInScope

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

log	back to summary
private static final InternalLogger log

registry	back to summary
private final ObservationRegistry registry

tracer	back to summary
private final Tracer tracer

Constructor Detail

ObservationAwareBaggageThreadLocalAccessor	back to summary
public ObservationAwareBaggageThreadLocalAccessor(ObservationRegistry observationRegistry, Tracer tracer) Creates a new instance of this class. Parameters observationRegistry:ObservationRegistry observation registry tracer:Tracer tracer Since 1.2.2

ObservationAwareBaggageThreadLocalAccessor

back to summary

public ObservationAwareBaggageThreadLocalAccessor(ObservationRegistry observationRegistry, Tracer tracer)

Creates a new instance of this class.

Parameters

observationRegistry:ObservationRegistry: observation registry
tracer:Tracer: tracer

Since

1.2.2

Method Detail

baggageScopeClosingScope	back to summary
private static ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope baggageScopeClosingScope(Map.Entry<String, String> entry, ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope scope, BaggageInScope baggage) Annotations @NonNull

closeCurrentScope	back to summary
private void closeCurrentScope()

getCurrentSpan	back to summary
private Span getCurrentSpan(Observation currentObservation)

getValue back to summary

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

openScopeForEachBaggageEntry	back to summary
private ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope openScopeForEachBaggageEntry(Set<Map.Entry<String, String>> entries, Span span, ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope scope)

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(BaggageToPropagate 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:BaggageToPropagate 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(BaggageToPropagate 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:BaggageToPropagate: previous value to set, never null when called from a ContextSnapshot * implementation, which is not allowed to store mappings to null.

Annotations

@Override

scopeClosingBaggageAndScope	back to summary
private static ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope scopeClosingBaggageAndScope(Map.Entry<String, String> entry, BaggageInScope baggage)

scopeRestoringBaggageAndScope	back to summary
private ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope scopeRestoringBaggageAndScope(ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope currentScope, ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope previousScope)

setValue back to summary

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

Field Summary

Modifier and Type	Field and Description
private final Consumer<Object>	consumer
private final Map.Entry<String, String>	entry
private static final InternalLogger	log

Access	Constructor and Description
pack-priv	BaggageAndScope(Consumer<Object> consumer, Map.Entry<String, String> entry)
pack-priv	BaggageAndScope(Consumer<Object> consumer)

Method Summary

Modifier and Type	Method and Description
public void	accept(Object the input argument o) Implements java.util.function.Consumer.accept. Performs this operation on the given argument.
public ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope	andThen(Consumer<? super Object> the operation to perform after this operation after) Overrides default java.util.function.Consumer.andThen. Returns a composed `Consumer` that performs, in sequence, this operation followed by the `after` operation.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

Field Detail

consumer	back to summary
private final Consumer<Object> consumer

entry	back to summary
private final Map.Entry<String, String> entry

log	back to summary
private static final InternalLogger log

Constructor Detail

BaggageAndScope	back to summary
pack-priv BaggageAndScope(Consumer<Object> consumer, Map.Entry<String, String> entry)

BaggageAndScope	back to summary
pack-priv BaggageAndScope(Consumer<Object> consumer)

Method Detail

accept	back to summary
public void accept(Object o) Implements java.util.function.Consumer.accept. Doc from java.util.function.Consumer.accept. Performs this operation on the given argument. Parameters o:Object the input argument Annotations @Override

back to summary

public void accept(Object o)

Implements java.util.function.Consumer.accept.

Doc from java.util.function.Consumer.accept.

Performs this operation on the given argument.

Parameters

o:Object: the input argument

Annotations

@Override

andThen back to summary

andThen	back to summary
public ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope andThen(Consumer<? super Object> after) Overrides default java.util.function.Consumer.andThen. Doc from java.util.function.Consumer.andThen. Returns a composed `Consumer` that performs, in sequence, this operation followed by the `after` operation. If performing either operation throws an exception, it is relayed to the caller of the composed operation. If performing this operation throws an exception, the `after` operation will not be performed. Parameters after:Consumer<? super Object> the operation to perform after this operation Returns:ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope a composed `Consumer` that performs in sequence this operation followed by the `after` operation Annotations @NonNull @Override

public ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope andThen(Consumer<? super Object> after)

Overrides default java.util.function.Consumer.andThen.

Doc from java.util.function.Consumer.andThen.

Returns a composed Consumer that performs, in sequence, this operation followed by the after operation. If performing either operation throws an exception, it is relayed to the caller of the composed operation. If performing this operation throws an exception, the after operation will not be performed.

Parameters

after:Consumer<? super Object>: the operation to perform after this operation

Returns:ObservationAwareBaggageThreadLocalAccessor.BaggageAndScope

a composed Consumer that performs in sequence this operation followed by the after operation

Annotations

@NonNull
@Override

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Returns:String a string representation of the object. Annotations @Override

toString

back to summary

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations