org.apache.htrace.core

Class MilliSpan

java.lang.Object

org.apache.htrace.core.MilliSpan

All Implemented Interfaces:

Span

public class MilliSpan
extends Object
implements Span

A Span implementation that stores its information in milliseconds since the epoch.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MilliSpan.Builder The public interface for constructing a MilliSpan.
static class	MilliSpan.MilliSpanDeserializer

Nested classes/interfaces inherited from interface org.apache.htrace.core.Span

Span.SpanSerializer

Constructor Summary

Constructors

Constructor and Description
MilliSpan()

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 childDescription) Create a child span of this span with the given description
protected long	currentTimeMillis()
static MilliSpan	fromJson(String json)
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 tracerId) Set the process id of a span.
void	stop() The block has completed, stop the clock
String	toJson() Serialize to Json
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MilliSpan

public MilliSpan()

Method Detail

child

public Span child(String childDescription)

Description copied from interface: Span

Create a child span of this span with the given description

Specified by:

child in interface Span

stop

public void stop()

Description copied from interface: Span

The block has completed, stop the clock

Specified by:

stop in interface Span

currentTimeMillis

protected long currentTimeMillis()

isRunning

public boolean isRunning()

Description copied from interface: Span

Has the span been started and not yet stopped?

Specified by:

isRunning in interface Span

getAccumulatedMillis

public long getAccumulatedMillis()

Description copied from interface: Span

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

Specified by:

getAccumulatedMillis in interface Span

toString

public String toString()

Specified by:

toString in interface Span

Overrides:

toString in class Object

getDescription

public String getDescription()

Description copied from interface: Span

Return a textual description of this span.

Will never be null.

Specified by:

getDescription in interface Span

getSpanId

public SpanId getSpanId()

Description copied from interface: Span

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.

Specified by:

getSpanId in interface Span

getParents

public SpanId[] getParents()

Description copied from interface: Span

Returns the parent IDs of the span.

The array will be empty if there are no parents.

Specified by:

getParents in interface Span

setParents

public void setParents(SpanId[] parents)

Description copied from interface: Span

Set the parents of this span.

Any existing parents will be cleared by this call.

Specified by:

setParents in interface Span

getStartTimeMillis

public long getStartTimeMillis()

Description copied from interface: Span

Get the start time, in milliseconds

Specified by:

getStartTimeMillis in interface Span

getStopTimeMillis

public long getStopTimeMillis()

Description copied from interface: Span

Get the stop time, in milliseconds

Specified by:

getStopTimeMillis in interface Span

addKVAnnotation

public void addKVAnnotation(String key,
                   String value)

Description copied from interface: Span

Add a data annotation associated with this span

Specified by:

addKVAnnotation in interface Span

addTimelineAnnotation

public void addTimelineAnnotation(String msg)

Description copied from interface: Span

Add a timeline annotation associated with this span

Specified by:

addTimelineAnnotation in interface Span

getKVAnnotations

public Map<String,String> getKVAnnotations()

Description copied from interface: Span

Get data associated with this span (read only)

Will never be null.

Specified by:

getKVAnnotations in interface Span

getTimelineAnnotations

public List<TimelineAnnotation> getTimelineAnnotations()

Description copied from interface: Span

Get any timeline annotations (read only)

Will never be null.

Specified by:

getTimelineAnnotations in interface Span

getTracerId

public String getTracerId()

Description copied from interface: Span

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

Will never be null.

Specified by:

getTracerId in interface Span

setTracerId

public void setTracerId(String tracerId)

Description copied from interface: Span

Set the process id of a span.

Specified by:

setTracerId in interface Span

toJson

public String toJson()

Description copied from interface: Span

Serialize to Json

Specified by:

toJson in interface Span

fromJson

public static MilliSpan fromJson(String json)
                          throws IOException

Throws:

IOException