A ContextStorage which keeps track of opened and closed Scopes, reporting caller information if a Scope is closed incorrectly or not at all.

Calling StrictContextStorage#close() will check at the moment it's called whether there are any scopes that have been opened but not closed yet. This could be called at the end of a unit test to ensure the tested code cleaned up scopes correctly.

Nested and Inner Type Summary

Modifier and Type	Class and Description
pack-priv static class	StrictContextStorage.CallerStackTrace
pack-priv static class	StrictContextStorage.PendingScopes
pack-priv class	StrictContextStorage.StrictScope

Modifier and Type	Field and Description
private final ContextStorage	delegate
private static final Logger	logger
private final StrictContextStorage.PendingScopes	pendingScopes

Access	Constructor and Description
private	StrictContextStorage(ContextStorage delegate)

Method Summary

Modifier and Type	Method and Description
public Scope	attach(Context context) Implements io.opentelemetry.context.ContextStorage.attach. Sets the specified `Context` as the current `Context` and returns a `Scope` representing the scope of execution.
pack-priv static AssertionError	callerError(StrictContextStorage.CallerStackTrace caller)
public void	close() Implements java.lang.AutoCloseable.close. Ensures all scopes that have been created by this storage have been closed.
pack-priv static StrictContextStorage	create(ContextStorage delegate) Returns a new `StrictContextStorage` which delegates to the provided `ContextStorage`, wrapping created scopes to track their usage.
public Context	current() Implements io.opentelemetry.context.ContextStorage.current. Returns the current `Context`.

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

Field Detail

delegate	back to summary
private final ContextStorage delegate

logger	back to summary
private static final Logger logger

pendingScopes	back to summary
private final StrictContextStorage.PendingScopes pendingScopes

Constructor Detail

StrictContextStorage	back to summary
private StrictContextStorage(ContextStorage delegate)

Method Detail

attach back to summary

attach	back to summary
public Scope attach(Context context) Implements io.opentelemetry.context.ContextStorage.attach. Doc from io.opentelemetry.context.ContextStorage.attach. Sets the specified `Context` as the current `Context` and returns a `Scope` representing the scope of execution. `Scope#close()` must be called when the current `Context` should be restored to what it was before attaching `toAttach`. Annotations @Override

public Scope attach(Context context)

Implements io.opentelemetry.context.ContextStorage.attach.

Doc from io.opentelemetry.context.ContextStorage.attach.

Sets the specified Context as the current Context and returns a Scope representing the scope of execution. Scope#close() must be called when the current Context should be restored to what it was before attaching toAttach.

Annotations

@Override

callerError	back to summary
pack-priv static AssertionError callerError(StrictContextStorage.CallerStackTrace caller)

close	back to summary
public void close() Implements java.lang.AutoCloseable.close. Ensures all scopes that have been created by this storage have been closed. This can be useful to call at the end of a test to make sure everything has been cleaned up. Note It is important to close all resources prior to calling this, so that in-flight operations are not mistaken as scope leaks. If this raises an error, consider if a Context#wrap(Executor) wrapped executor} is still running. Annotations @Override Exceptions AssertionError: if any scopes were left unclosed.

back to summary

public void close()

Implements java.lang.AutoCloseable.close.

Ensures all scopes that have been created by this storage have been closed. This can be useful to call at the end of a test to make sure everything has been cleaned up.

Note

It is important to close all resources prior to calling this, so that in-flight operations are not mistaken as scope leaks. If this raises an error, consider if a Context#wrap(Executor) wrapped executor} is still running.

Annotations

@Override

Exceptions

AssertionError:: if any scopes were left unclosed.

create	back to summary
pack-priv static StrictContextStorage create(ContextStorage delegate) Returns a new `StrictContextStorage` which delegates to the provided `ContextStorage`, wrapping created scopes to track their usage.

current back to summary

current	back to summary
public Context current() Implements io.opentelemetry.context.ContextStorage.current. Doc from io.opentelemetry.context.ContextStorage.current. Returns the current `Context`. If no `Context` has been attached yet, this will return `null`. Annotations @Override @Nullable

public Context current()

Implements io.opentelemetry.context.ContextStorage.current.

Doc from io.opentelemetry.context.ContextStorage.current.

Returns the current Context. If no Context has been attached yet, this will return null.

Annotations

@Override
@Nullable

io.opentelemetry.context back to summary

pack-priv Class StrictContextStorage.CallerStackTrace

Class Inheritance

extends Throwable

java.lang.Object
java.lang.Throwable
io.opentelemetry.context.StrictContextStorage.CallerStackTrace

Annotations

@SuppressWarnings:serial

Field Summary

Modifier and Type	Field and Description
pack-priv volatile boolean	closed
pack-priv final Context	context
pack-priv final long	threadId
pack-priv final String	threadName

Constructor Summary

Access	Constructor and Description
pack-priv	CallerStackTrace(Context context)

Method Summary

Inherited from java.lang.Throwable:: addSuppressed fillInStackTrace getCause getLocalizedMessage getMessage getStackTrace getSuppressed initCause printStackTrace printStackTrace printStackTrace setStackTrace toString

Field Detail

closed	back to summary
pack-priv volatile boolean closed

context	back to summary
pack-priv final Context context

threadId	back to summary
pack-priv final long threadId

threadName	back to summary
pack-priv final String threadName

Constructor Detail

CallerStackTrace	back to summary
pack-priv CallerStackTrace(Context context)

io.opentelemetry.context back to summary

pack-priv Class StrictContextStorage.PendingScopes

Class Inheritance

extends WeakConcurrentMap<Scope, StrictContextStorage.CallerStackTrace>

java.lang.Object
java.lang.ref.ReferenceQueue
io.opentelemetry.context.internal.shaded.AbstractWeakConcurrentMap
io.opentelemetry.context.internal.shaded.WeakConcurrentMap
io.opentelemetry.context.StrictContextStorage.PendingScopes

Field Summary

Modifier and Type	Field and Description
private final ConcurrentHashMap<AbstractWeakConcurrentMap.WeakKey<Scope>, StrictContextStorage.CallerStackTrace>	map

Constructor Summary

Access	Constructor and Description
pack-priv	PendingScopes(ConcurrentHashMap<AbstractWeakConcurrentMap.WeakKey<Scope>, StrictContextStorage.CallerStackTrace> map)

Method Summary

Modifier and Type	Method and Description
pack-priv static StrictContextStorage.PendingScopes	create()
pack-priv List<StrictContextStorage.CallerStackTrace>	drainPendingCallers()
public void	run() Overrides io.opentelemetry.context.internal.shaded.AbstractWeakConcurrentMap.run. Implements java.lang.Runnable.run. Runs this operation.

Inherited from io.opentelemetry.context.internal.shaded.WeakConcurrentMap:: getCleanerThread getLookupKey resetLookupKey

Field Detail

map	back to summary
private final ConcurrentHashMap<AbstractWeakConcurrentMap.WeakKey<Scope>, StrictContextStorage.CallerStackTrace> map

Constructor Detail

PendingScopes	back to summary
pack-priv PendingScopes(ConcurrentHashMap<AbstractWeakConcurrentMap.WeakKey<Scope>, StrictContextStorage.CallerStackTrace> map) Annotations @SuppressWarnings:ThreadPriorityCheck

Method Detail

create	back to summary
pack-priv static StrictContextStorage.PendingScopes create()

drainPendingCallers	back to summary
pack-priv List<StrictContextStorage.CallerStackTrace> drainPendingCallers()

run	back to summary
public void run() Overrides io.opentelemetry.context.internal.shaded.AbstractWeakConcurrentMap.run. Implements java.lang.Runnable.run. Doc from java.lang.Runnable.run. Runs this operation. Annotations @Override

run

back to summary

public void run()

Overrides io.opentelemetry.context.internal.shaded.AbstractWeakConcurrentMap.run.

Implements java.lang.Runnable.run.

Doc from java.lang.Runnable.run.

Runs this operation.

Annotations

@Override

io.opentelemetry.context back to summary

pack-priv final Class StrictContextStorage.StrictScope

Class Inheritance

extends Object
implements Scope

java.lang.Object
io.opentelemetry.context.StrictContextStorage.StrictScope

All Implemented Interfaces

io.opentelemetry.context.Scope, java.lang.AutoCloseable

Field Summary

Modifier and Type	Field and Description
pack-priv final StrictContextStorage.CallerStackTrace	caller
pack-priv final Scope	delegate

Constructor Summary

Access	Constructor and Description
pack-priv	StrictScope(Scope delegate, StrictContextStorage.CallerStackTrace caller)

Method Summary

Modifier and Type	Method and Description
public void	close() Implements io.opentelemetry.context.Scope.close. Closes this resource, relinquishing any underlying resources.
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

caller	back to summary
pack-priv final StrictContextStorage.CallerStackTrace caller

delegate	back to summary
pack-priv final Scope delegate

Constructor Detail

StrictScope	back to summary
pack-priv StrictScope(Scope delegate, StrictContextStorage.CallerStackTrace caller)

Method Detail

close back to summary

close	back to summary
public void close() Implements io.opentelemetry.context.Scope.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 io.opentelemetry.context.Scope.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

toString back to summary

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. Satisfying this method's contract implies a non-`null` result must be returned. Returns:String a string representation of the object Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Returns:String

a string representation of the object

Annotations

@Override