kanela.agent.bootstrap.tracing

Enum TraceProvider.NoOp

java.lang.Object

java.lang.Enum<TraceProvider.NoOp>

kanela.agent.bootstrap.tracing.TraceProvider.NoOp

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TraceProvider.NoOp>, TraceProvider

Enclosing interface:

TraceProvider

public static enum TraceProvider.NoOp
extends java.lang.Enum<TraceProvider.NoOp>
implements TraceProvider

Nested Class Summary

Nested classes/interfaces inherited from interface kanela.agent.bootstrap.tracing.TraceProvider

TraceProvider.NoOp

Enum Constant Summary

Enum Constants

Enum Constant and Description
INSTANCE

Method Summary

Modifier and Type	Method and Description
void	finishSpan(java.io.Closeable scope, java.lang.Throwable throwable) Ends the current span with a status derived from the given (optional) Throwable, and closes the given scope.
java.io.Closeable	startSpan(java.lang.String spanName) Starts a new span and sets it as the current span.
static TraceProvider.NoOp	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TraceProvider.NoOp[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final TraceProvider.NoOp INSTANCE

Method Detail

values

public static TraceProvider.NoOp[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TraceProvider.NoOp c : TraceProvider.NoOp.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TraceProvider.NoOp valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

startSpan

public java.io.Closeable startSpan(java.lang.String spanName)

Description copied from interface: TraceProvider

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 kamon.trace.Span#finish.

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

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

Specified by:

startSpan in interface TraceProvider

Parameters:

spanName - the name of the returned kamon.trace.Span

Returns:

an object that defines a scope where the newly created Span will be set to the current Context kamon.trace.Tracer#buildSpan(java.lang.String)

finishSpan

public void finishSpan(java.io.Closeable scope,
                       java.lang.Throwable throwable)

Description copied from interface: TraceProvider

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

Specified by:

finishSpan in interface TraceProvider

Parameters:

scope - an object representing the scope

throwable - an optional Throwable