io.opentracing

Class APMSpan

java.lang.Object

io.opentracing.APMSpan

All Implemented Interfaces:

io.opentracing.Span, io.opentracing.SpanContext, AutoCloseable

public class APMSpan
extends Object

The APM span.

Author:

gbrown

Constructor Summary

Constructors

Constructor and Description
APMSpan(APMSpanBuilder builder, TraceReporter reporter)

Method Summary

Modifier and Type	Method and Description
Iterable<Map.Entry<String,String>>	baggageItems()
void	close()
io.opentracing.SpanContext	context()
void	finish()
void	finish(long finishMicros)
Map<String,String>	getBaggage()
String	getBaggageItem(String arg0)
Duration	getDuration()
protected String	getInteractionId()
List<io.opentracing.AbstractSpan.LogData>	getLogs()
protected NodeBuilder	getNodeBuilder() This method returns the node builder associated with the span.
protected String	getNodePath()
String	getOperationName()
Instant	getStart()
Map<String,Object>	getTags()
protected TraceContext	getTraceContext() This method returns the trace context associated with the span.
protected void	init(APMSpanBuilder builder, TraceReporter reporter)
protected void	initChildOf(APMSpanBuilder builder, TraceReporter reporter, io.opentracing.AbstractSpanBuilder.Reference ref) This method initialises the span based on a 'child-of' relationship.
protected void	initFollowsFrom(APMSpanBuilder builder, TraceReporter reporter, io.opentracing.AbstractSpanBuilder.Reference ref) This method initialises the span based on a 'follows-from' relationship.
protected void	initTopLevelState(APMSpan topSpan, TraceReporter reporter) This method initialises the node builder and trace context for a top level trace fragment.
io.opentracing.Span	log(long arg0, Map<String,?> arg1)
io.opentracing.Span	log(long arg0, String arg1)
io.opentracing.Span	log(long arg0, String arg1, Object arg2)
io.opentracing.Span	log(Map<String,?> arg0)
io.opentracing.Span	log(String arg0)
io.opentracing.Span	log(String arg0, Object arg1)
io.opentracing.AbstractSpan	setBaggageItem(String arg0, String arg1)
protected void	setInteractionId(String id, NodeType nodeType)
io.opentracing.Span	setOperationName(String arg0)
io.opentracing.Span	setTag(String arg0, boolean arg1)
io.opentracing.Span	setTag(String arg0, Number arg1)
io.opentracing.Span	setTag(String arg0, String arg1)

Methods inherited from class java.lang.Object

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

Constructor Detail

APMSpan

public APMSpan(APMSpanBuilder builder,
               TraceReporter reporter)

Parameters:

builder - The span builder

reporter - The trace reporter

Method Detail

init

protected void init(APMSpanBuilder builder,
                    TraceReporter reporter)

initTopLevelState

protected void initTopLevelState(APMSpan topSpan,
                                 TraceReporter reporter)

This method initialises the node builder and trace context for a top level trace fragment.

Parameters:

topSpan - The top level span in the trace

reporter - The trace reporter

initChildOf

protected void initChildOf(APMSpanBuilder builder,
                           TraceReporter reporter,
                           io.opentracing.AbstractSpanBuilder.Reference ref)

This method initialises the span based on a 'child-of' relationship.

Parameters:

builder - The span builder

reporter - The trace reporter

ref - The 'child-of' relationship

initFollowsFrom

protected void initFollowsFrom(APMSpanBuilder builder,
                               TraceReporter reporter,
                               io.opentracing.AbstractSpanBuilder.Reference ref)

This method initialises the span based on a 'follows-from' relationship.

Parameters:

builder - The span builder

reporter - The trace reporter

ref - The 'follows-from' relationship

setInteractionId

protected void setInteractionId(String id,
                                NodeType nodeType)

getInteractionId

protected String getInteractionId()

getNodePath

protected String getNodePath()

finish

public void finish()

Specified by:

finish in interface io.opentracing.Span

finish

public void finish(long finishMicros)

Specified by:

finish in interface io.opentracing.Span

getNodeBuilder

protected NodeBuilder getNodeBuilder()

This method returns the node builder associated with the span.

Returns:

The node builder

getTraceContext

protected TraceContext getTraceContext()

This method returns the trace context associated with the span.

Returns:

The trace context

context

public final io.opentracing.SpanContext context()

Specified by:

context in interface io.opentracing.Span

getOperationName

public final String getOperationName()

setOperationName

public io.opentracing.Span setOperationName(String arg0)

Specified by:

setOperationName in interface io.opentracing.Span

getStart

public final Instant getStart()

getDuration

public final Duration getDuration()

close

public final void close()

Specified by:

close in interface io.opentracing.Span

Specified by:

close in interface AutoCloseable

setTag

public final io.opentracing.Span setTag(String arg0,
                                        String arg1)

Specified by:

setTag in interface io.opentracing.Span

setTag

public final io.opentracing.Span setTag(String arg0,
                                        boolean arg1)

Specified by:

setTag in interface io.opentracing.Span

setTag

public final io.opentracing.Span setTag(String arg0,
                                        Number arg1)

Specified by:

setTag in interface io.opentracing.Span

getTags

public final Map<String,Object> getTags()

setBaggageItem

public io.opentracing.AbstractSpan setBaggageItem(String arg0,
                                                  String arg1)

Specified by:

setBaggageItem in interface io.opentracing.Span

getBaggageItem

public String getBaggageItem(String arg0)

Specified by:

getBaggageItem in interface io.opentracing.Span

baggageItems

public final Iterable<Map.Entry<String,String>> baggageItems()

Specified by:

baggageItems in interface io.opentracing.SpanContext

getBaggage

public final Map<String,String> getBaggage()

log

public final io.opentracing.Span log(String arg0)

Specified by:

log in interface io.opentracing.Span

log

public final io.opentracing.Span log(long arg0,
                                     String arg1)

Specified by:

log in interface io.opentracing.Span

log

public final io.opentracing.Span log(Map<String,?> arg0)

Specified by:

log in interface io.opentracing.Span

log

public final io.opentracing.Span log(long arg0,
                                     Map<String,?> arg1)

Specified by:

log in interface io.opentracing.Span

log

public final io.opentracing.Span log(String arg0,
                                     Object arg1)

Specified by:

log in interface io.opentracing.Span

log

public final io.opentracing.Span log(long arg0,
                                     String arg1,
                                     Object arg2)

Specified by:

log in interface io.opentracing.Span

getLogs

public final List<io.opentracing.AbstractSpan.LogData> getLogs()