io.opentracing.impl

Class APMSpan

java.lang.Object

io.opentracing.impl.APMSpan

All Implemented Interfaces:

PropagableState, io.opentracing.Span, io.opentracing.SpanContext, Closeable, AutoCloseable

public class APMSpan
extends Object
implements PropagableState

The APM span.

Author:

gbrown

Constructor Summary

Constructors

Constructor and Description
APMSpan(APMSpanBuilder builder, TraceRecorder recorder, ContextSampler sampler)

Method Summary

Modifier and Type	Method and Description
Iterable<Map.Entry<String,String>>	baggageItems()
void	close()
io.opentracing.SpanContext	context()
static io.opentracing.impl.AbstractSpanBuilder.Reference	findPrimaryReference(List<io.opentracing.impl.AbstractSpanBuilder.Reference> references) This method identifies the primary 'parent' reference that should be used to link the associated span to an existing trace instance.
void	finish()
void	finish(long finishMicros)
Map<String,String>	getBaggage()
String	getBaggageItem(String arg0)
Duration	getDuration()
protected String	getInteractionId()
List<io.opentracing.impl.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, TraceRecorder recorder, ContextSampler sampler)
protected void	initChildOf(APMSpanBuilder builder, io.opentracing.impl.AbstractSpanBuilder.Reference ref) This method initialises the span based on a 'child-of' relationship.
protected void	initFollowsFrom(APMSpanBuilder builder, TraceRecorder recorder, io.opentracing.impl.AbstractSpanBuilder.Reference ref, ContextSampler sampler) This method initialises the span based on a 'follows-from' relationship.
protected void	initFromExtractedTraceState(APMSpanBuilder builder, TraceRecorder recorder, io.opentracing.impl.AbstractSpanBuilder.Reference ref, ContextSampler sampler) This method initialises the span based on extracted trace state.
protected void	initReferences(APMSpanBuilder builder, TraceRecorder recorder, ContextSampler sampler)
protected void	initTopLevelState(APMSpan topSpan, TraceRecorder recorder, ContextSampler sampler) 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)
protected void	makeInternalLink(APMSpanBuilder builder) This method creates a Consumer node to link the new trace fragment to a node associated with a referenced Span.
protected void	processNoPrimaryReference(APMSpanBuilder builder, TraceRecorder recorder, ContextSampler sampler) This method initialises the span based on there being no primary reference.
protected void	processRemainingReferences(APMSpanBuilder builder, io.opentracing.impl.AbstractSpanBuilder.Reference primaryRef) This method processes the remaining references by creating appropriate correlation ids against the current node.
io.opentracing.impl.AbstractSpan	setBaggageItem(String arg0, String arg1)
protected void	setInteractionId(String id)
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)
Map<String,Object>	state() State properties defining span(or APM trace fragment) state.

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,
               TraceRecorder recorder,
               ContextSampler sampler)

Parameters:

builder - The span builder

recorder - The trace recorder

Method Detail

init

protected void init(APMSpanBuilder builder,
                    TraceRecorder recorder,
                    ContextSampler sampler)

initReferences

protected void initReferences(APMSpanBuilder builder,
                              TraceRecorder recorder,
                              ContextSampler sampler)

findPrimaryReference

public static io.opentracing.impl.AbstractSpanBuilder.Reference findPrimaryReference(List<io.opentracing.impl.AbstractSpanBuilder.Reference> references)

This method identifies the primary 'parent' reference that should be used to link the associated span to an existing trace instance.

Parameters:

references - The list of references

Returns:

The primary reference, or null if one could not be determined

initTopLevelState

protected void initTopLevelState(APMSpan topSpan,
                                 TraceRecorder recorder,
                                 ContextSampler sampler)

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

Parameters:

topSpan - The top level span in the trace

recorder - The trace recorder

sampler - The sampler

initFromExtractedTraceState

protected void initFromExtractedTraceState(APMSpanBuilder builder,
                                           TraceRecorder recorder,
                                           io.opentracing.impl.AbstractSpanBuilder.Reference ref,
                                           ContextSampler sampler)

This method initialises the span based on extracted trace state.

Parameters:

builder - The span builder

recorder - The trace recorder

ref - The reference

sampler - The sampler

initChildOf

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

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

Parameters:

builder - The span builder

ref - The 'child-of' relationship

initFollowsFrom

protected void initFollowsFrom(APMSpanBuilder builder,
                               TraceRecorder recorder,
                               io.opentracing.impl.AbstractSpanBuilder.Reference ref,
                               ContextSampler sampler)

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

Parameters:

builder - The span builder

recorder - The trace recorder

ref - The 'follows-from' relationship

sampler - The sampler

processNoPrimaryReference

protected void processNoPrimaryReference(APMSpanBuilder builder,
                                         TraceRecorder recorder,
                                         ContextSampler sampler)

This method initialises the span based on there being no primary reference.

Parameters:

builder - The span builder

recorder - The trace recorder

sampler - The sampler

processRemainingReferences

protected void processRemainingReferences(APMSpanBuilder builder,
                                          io.opentracing.impl.AbstractSpanBuilder.Reference primaryRef)

This method processes the remaining references by creating appropriate correlation ids against the current node.

Parameters:

builder - The span builder

primaryRef - The primary reference, if null if one was not found

makeInternalLink

protected void makeInternalLink(APMSpanBuilder builder)

This method creates a Consumer node to link the new trace fragment to a node associated with a referenced Span. This method sets the type of the current node to be Consumer, initialises its URI/Operation to the endpoint details of the supplied trace context, and then creates a new child node upon which subsequent configuration will be performed.

Parameters:

builder - The span builder

setInteractionId

protected void setInteractionId(String id)

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

state

public Map<String,Object> state()

Description copied from interface: PropagableState

State properties defining span(or APM trace fragment) state.

Specified by:

state in interface PropagableState

Returns:

map containing state objects which should be propagated between called services.

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 Closeable

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.impl.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.impl.AbstractSpan.LogData> getLogs()