io.opencensus.contrib.agent.bootstrap

Interface TraceStrategy

public interface TraceStrategy

Strategy interface for creating and manipulating trace spans.

Since:

0.9

Method Summary

Modifier and Type	Method and Description
void	endScope(Closeable scope, Throwable throwable) Ends the current span with a status derived from the given (optional) Throwable, and closes the given scope.
Closeable	startScopedSpan(String spanName) Starts a new span and sets it as the current span.

Method Detail

startScopedSpan

@MustBeClosed
Closeable startScopedSpan(String spanName)

Starts a new span and sets it as the current span.

Enters the scope of code where the newly created Span is in the current Context, and returns an object that represents that scope. When the returned object is closed, the scope is exited, the previous Context is restored, and the newly created Span is ended using Span.end(io.opencensus.trace.EndSpanOptions).

Callers must eventually close the returned object to avoid leaking the Context.

Supports the try-with-resource idiom.

NB: The return type of this method is intentionally Closeable and not the more specific Scope because the latter would not be visible from classes loaded by the bootstrap classloader.

Parameters:

spanName - the name of the returned Span

Returns:

an object that defines a scope where the newly created Span will be set to the current Context

Since:

0.9

See Also:

Tracer.spanBuilder(java.lang.String), SpanBuilder.startScopedSpan()

endScope

void endScope(Closeable scope,
              @Nullable
              Throwable throwable)

Ends the current span with a status derived from the given (optional) Throwable, and closes the given scope.

Parameters:

scope - an object representing the scope

throwable - an optional Throwable

Since:

0.9