Package io.opentelemetry.context

Class StrictContextStorage

java.lang.Object

io.opentelemetry.context.StrictContextStorage

All Implemented Interfaces:

ContextStorage, AutoCloseable

final class StrictContextStorage
extends Object
implements ContextStorage, AutoCloseable

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

Calling 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 Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	StrictContextStorage.CallerStackTrace
(package private) static class	StrictContextStorage.PendingScopes
(package private) final class	StrictContextStorage.StrictScope

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor	Description
private	StrictContextStorage(ContextStorage delegate)

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.
(package private) static AssertionError	callerError(StrictContextStorage.CallerStackTrace caller)
void	close()	Ensures all scopes that have been created by this storage have been closed.
(package private) 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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.opentelemetry.context.ContextStorage

root

Field Details

logger

private static final Logger logger

delegate

private final ContextStorage delegate

pendingScopes

private final StrictContextStorage.PendingScopes pendingScopes

Constructor Details

StrictContextStorage

private StrictContextStorage(ContextStorage delegate)

Method Details

create

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

@Nullable
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

close

public void 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.

Specified by:

close in interface AutoCloseable

Throws:

AssertionError - if any scopes were left unclosed.

callerError

static AssertionError callerError(StrictContextStorage.CallerStackTrace caller)