Package io.opentelemetry.context

Class StrictContextStorage

java.lang.Object

io.opentelemetry.context.StrictContextStorage

All Implemented Interfaces:

ContextStorage

public final class StrictContextStorage
extends Object
implements ContextStorage

A ContextStorage which keeps track of opened and closed Scopes, reporting caller information if a Scope is closed incorrectly or not at all. This is useful in instrumentation tests to check whether any scopes leaked.

 > class MyInstrumentationTest {
 >   private static ContextStorage previousStorage;
 >   private static StrictContextStorage strictStorage;
 >
 >   @BeforeAll
 >   static void setUp() {
 >     previousStorage = ContextStorage.get()
 >     strictStorage = StrictContextStorage.create(previousStorage);
 >     ContextStorage.set(strictStorage);
 >   }
 >
 >   @AfterEach
 >   void checkScopes() {
 >     strictStorage.ensureAllClosed();
 >   }
 >
 >   @AfterAll
 >   static void tearDown() {
 >     ContextStorage.set(previousStorage);
 >   }
 >
 >   @Test
 >   void badTest() {
 >     Context.root().makeCurrent();
 >   }
 > }
 

Method Summary

Modifier and Type	Method	Description
Scope	attach(Context context)	Sets the specified Context as the current Context and returns a Scope representing the scope of execution.
static StrictContextStorage	create(ContextStorage delegate)	Returns a new StrictContextStorage which delegates to the provided ContextStorage, wrapping created scopes to track their usage.
Context	current()	Returns the current Context.
void	ensureAllClosed()	Ensures all scopes that have been created by this storage have been closed.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static StrictContextStorage create(ContextStorage delegate)

Returns a new StrictContextStorage which delegates to the provided ContextStorage, wrapping created scopes to track their usage.

attach

public Scope attach(Context context)

Description copied from interface: ContextStorage

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.

Specified by:

attach in interface ContextStorage

current

public Context current()

Description copied from interface: ContextStorage

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

Specified by:

current in interface ContextStorage

ensureAllClosed

public void ensureAllClosed()

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.

Throws:

AssertionError - if any scopes were left unclosed.