org.apache.htrace.core

Class TraceScope

java.lang.Object

org.apache.htrace.core.TraceScope

All Implemented Interfaces:

Closeable, AutoCloseable

public class TraceScope
extends Object
implements Closeable

Create a new TraceScope at major transitions. Hosts current tracing context.

Method Summary

Methods

Modifier and Type	Method and Description
void	addKVAnnotation(String key, String value)
void	addTimelineAnnotation(String msg)
void	close() Close this TraceScope, ending the trace span it is managing.
void	detach() Detach this TraceScope from the current thread.
Span	getSpan() Returns the span which this scope is managing.
SpanId	getSpanId() Returns the span ID which this scope is managing.
void	reattach() Attach this TraceScope to the current thread.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

getSpan

public Span getSpan()

Returns the span which this scope is managing.

getSpanId

public SpanId getSpanId()

Returns the span ID which this scope is managing.

detach

public void detach()

Detach this TraceScope from the current thread. It is OK to "leak" TraceScopes which have been detached. They will not consume any resources other than a small amount of memory until they are garbage collected. On the other hand, trace scopes which are still attached must never be leaked.

reattach

public void reattach()

Attach this TraceScope to the current thread.

close

public void close()

Close this TraceScope, ending the trace span it is managing.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

addKVAnnotation

public void addKVAnnotation(String key,
                   String value)

addTimelineAnnotation

public void addTimelineAnnotation(String msg)

toString

public String toString()

Overrides:

toString in class Object