public final class Tracing
Tracing is a singleton to interact with registered Tracer implementations.
Support for actual tracing libraries is done by implementing wrappers following the Tracer interface. The actual Tracer implementations must be registered using registerTracer.
The Tracing singleton is also an entry point used to create the root span for any tests by invoking the beginSpan method. The returned Span object must be properly closed by invoking the Span#close() method or wrapping them in a try-resource block.
Public methods |
|
|---|---|
@NonNull Tracer.Span |
Returns a new Span as a managed resource in a try{} block. |
static @NonNull Tracing |
Static getter for external access to the singleton. |
@NonNull void |
registerTracer(@NonNull Tracer tracer)Registers a new tracer. |
@NonNull void |
unregisterTracer(@NonNull Tracer tracer)Unregisters a tracer. |
@NonNull
public Tracer.Span beginSpan(@NonNull String name)
Returns a new Span as a managed resource in a try{} block. Span#close() is automatically called when the resource is released.
@NonNull
public static Tracing getInstance()
Static getter for external access to the singleton. Preferred method for internal Espresso is getting this singleton via dagger injection.
@NonNull
public void registerTracer(@NonNull Tracer tracer)
Registers a new tracer.
Once a tracer is registered, it starts being invoked for new root beginSpan calls. Existing in-flight spans do not invoke the new tracer.
@NonNull
public void unregisterTracer(@NonNull Tracer tracer)
Unregisters a tracer.
Once a tracer is unregistered, it will stop being invoked for any new root calls made or any new Span#beginChildSpan(String). However the tracer is still be called for any in-flight spans being closed.