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

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.
Map<String,String>	getKVAnnotations() Get the key-value annotations associated with this span.
SpanId[]	getParents() Returns the parent IDs of the span.
SpanId	getSpanId() A pseudo-unique (random) number assigned to this span instance.
long	getStartTimeMillis() Get the span start time.
long	getStopTimeMillis() Get the span stop time.
List<TimelineAnnotation>	getTimelineAnnotations() Get the timeline annotation list.
String	getTracerId() Return a unique id for the process from which this Span originated.
boolean	isRunning() Has the span been started and not yet stopped?
void	setParents(SpanId[] parents) Set the parents of this span.
void	setTracerId(String tracerId) Set the tracer 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

Parameters:

childDescription - The description to set on the child span.

Returns:

A new child 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

Returns:

True if the span is still running (has no stop time).

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

Returns:

The elapsed time in milliseconds.

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.

Specified by:

getDescription in interface Span

Returns:

The description of this span. Will never be null.

getSpanId

public SpanId getSpanId()

Description copied from interface: Span

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

Specified by:

getSpanId in interface Span

Returns:

The spanID. This object is immutable and is safe to access from multiple threads.

getParents

public SpanId[] getParents()

Description copied from interface: Span

Returns the parent IDs of the span.

Specified by:

getParents in interface Span

Returns:

The array of parents, or an empty array if there are no parents.

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

Parameters:

parents - The parents to set.

getStartTimeMillis

public long getStartTimeMillis()

Description copied from interface: Span

Get the span start time.

Specified by:

getStartTimeMillis in interface Span

Returns:

The start time, in approximate milliseconds since the epoch.

getStopTimeMillis

public long getStopTimeMillis()

Description copied from interface: Span

Get the span stop time.

Specified by:

getStopTimeMillis in interface Span

Returns:

The stop time, in approximate milliseconds since the epoch.

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

Parameters:

key - The key to set.

value - The value to set.

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

Parameters:

msg - The annotation to set. It will be associated with the current time.

getKVAnnotations

public Map<String,String> getKVAnnotations()

Description copied from interface: Span

Get the key-value annotations associated with this span.

Specified by:

getKVAnnotations in interface Span

Returns:

The annotation map in read-only form. Will never be null.

getTimelineAnnotations

public List<TimelineAnnotation> getTimelineAnnotations()

Description copied from interface: Span

Get the timeline annotation list.

Specified by:

getTimelineAnnotations in interface Span

Returns:

The annotation list in read-only form. Will never be null.

getTracerId

public String getTracerId()

Description copied from interface: Span

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

Specified by:

getTracerId in interface Span

Returns:

The tracer id. Will never be null.

setTracerId

public void setTracerId(String tracerId)

Description copied from interface: Span

Set the tracer id of a span.

Specified by:

setTracerId in interface Span

Parameters:

tracerId - The tracer ID to set.

toJson

public String toJson()

Description copied from interface: Span

Serialize to Json

Specified by:

toJson in interface Span

Returns:

A JSON string with the span data.

fromJson

public static MilliSpan fromJson(String json)
                          throws IOException

Throws:

IOException