org.apache.htrace.core

Interface Span

All Known Implementing Classes:

MilliSpan

public interface Span

Base interface for gathering and reporting statistics about a block of execution.

Spans should form a directed acyclic graph structure. It should be possible to keep following the parents of a span until you arrive at a span with no parents.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Span.SpanSerializer

Method Summary

Methods

Modifier and Type	Method and Description
void	addKVAnnotation(String key, String value) Add a data annotation associated with this span
void	addTimelineAnnotation(String msg) Add a timeline annotation associated with this span
Span	child(String description) Deprecated. Since 4.0.0. Use MilliSpan.Builder
long	getAccumulatedMillis() Return the total amount of time elapsed since start was called, if running, or difference between stop and start
String	getDescription() Return a textual description of this span. Will never be null.
Map<String,String>	getKVAnnotations() Get data associated with this span (read only) Will never be null.
SpanId[]	getParents() Returns the parent IDs of the span. The array will be empty if there are no parents.
SpanId	getSpanId() A pseudo-unique (random) number assigned to this span instance. The spanId is immutable and cannot be changed.
long	getStartTimeMillis() Get the start time, in milliseconds
long	getStopTimeMillis() Get the stop time, in milliseconds
List<TimelineAnnotation>	getTimelineAnnotations() Get any timeline annotations (read only) Will never be null.
String	getTracerId() Return a unique id for the process from which this Span originated. Will never be null.
boolean	isRunning() Has the span been started and not yet stopped?
void	setParents(SpanId[] parents) Set the parents of this span. Any existing parents will be cleared by this call.
void	setTracerId(String s) Set the process id of a span.
void	stop() The block has completed, stop the clock
String	toJson() Serialize to Json
String	toString()

Method Detail

stop

void stop()

The block has completed, stop the clock

getStartTimeMillis

long getStartTimeMillis()

Get the start time, in milliseconds

getStopTimeMillis

long getStopTimeMillis()

Get the stop time, in milliseconds

getAccumulatedMillis

long getAccumulatedMillis()

Return the total amount of time elapsed since start was called, if running, or difference between stop and start

isRunning

boolean isRunning()

Has the span been started and not yet stopped?

getDescription

String getDescription()

Return a textual description of this span.

Will never be null.

getSpanId

SpanId getSpanId()

A pseudo-unique (random) number assigned to this span instance.

The spanId is immutable and cannot be changed. It is safe to access this from multiple threads.

child

@Deprecated
Span child(String description)

Deprecated. Since 4.0.0. Use MilliSpan.Builder

Create a child span of this span with the given description

toString

String toString()

Overrides:

toString in class Object

getParents

SpanId[] getParents()

Returns the parent IDs of the span.

The array will be empty if there are no parents.

setParents

void setParents(SpanId[] parents)

Set the parents of this span.

Any existing parents will be cleared by this call.

addKVAnnotation

void addKVAnnotation(String key,
                   String value)

Add a data annotation associated with this span

addTimelineAnnotation

void addTimelineAnnotation(String msg)

Add a timeline annotation associated with this span

getKVAnnotations

Map<String,String> getKVAnnotations()

Get data associated with this span (read only)

Will never be null.

getTimelineAnnotations

List<TimelineAnnotation> getTimelineAnnotations()

Get any timeline annotations (read only)

Will never be null.

getTracerId

String getTracerId()

Return a unique id for the process from which this Span originated.

Will never be null.

setTracerId

void setTracerId(String s)

Set the process id of a span.

toJson

String toJson()

Serialize to Json