Class SpanBuilderImpl

java.lang.Object

io.opencensus.trace.SpanBuilder

io.opencensus.implcore.trace.SpanBuilderImpl

final class SpanBuilderImpl
extends SpanBuilder

Implementation of the SpanBuilder.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	SpanBuilderImpl.Options

Field Summary

Fields

Modifier and Type	Field	Description
private Span.Kind	kind
private final String	name
private static final TraceOptions	NOT_SAMPLED_TRACE_OPTIONS
private final SpanBuilderImpl.Options	options
private final Span	parent
private List<Span>	parentLinks
private Boolean	recordEvents
private final SpanContext	remoteParentSpanContext
private static final TraceOptions	SAMPLED_TRACE_OPTIONS
private Sampler	sampler
private static final Tracestate	TRACESTATE_DEFAULT

Constructor Summary

Constructors

Modifier	Constructor	Description
private	SpanBuilderImpl(String name, SpanContext remoteParentSpanContext, Span parent, SpanBuilderImpl.Options options)

Method Summary

Modifier and Type	Method	Description
(package private) static SpanBuilderImpl	createWithParent(String spanName, Span parent, SpanBuilderImpl.Options options)
(package private) static SpanBuilderImpl	createWithRemoteParent(String spanName, SpanContext remoteParentSpanContext, SpanBuilderImpl.Options options)
private static boolean	isAnyParentLinkSampled(List<Span> parentLinks)
private static void	linkSpans(Span span, List<Span> parentLinks)
private static boolean	makeSamplingDecision(SpanContext parent, Boolean hasRemoteParent, String name, Sampler sampler, List<Span> parentLinks, TraceId traceId, SpanId spanId, TraceParams activeTraceParams)
SpanBuilderImpl	setParentLinks(List<Span> parentLinks)	Sets the List of parent links.
SpanBuilderImpl	setRecordEvents(boolean recordEvents)	Sets the option Span.Options.RECORD_EVENTS for the newly created Span.
SpanBuilderImpl	setSampler(Sampler sampler)	Sets the Sampler to use.
SpanBuilderImpl	setSpanKind(Span.Kind kind)	Sets the Span.Kind for the newly created Span.
Span	startSpan()	Starts a new Span.
private Span	startSpanInternal(SpanContext parentContext, Boolean hasRemoteParent, String name, Sampler sampler, List<Span> parentLinks, Boolean recordEvents, Span.Kind kind, Span parentSpan)

Methods inherited from class SpanBuilder

startScopedSpan, startSpanAndCall, startSpanAndRun

Methods inherited from class Object

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

Field Details

TRACESTATE_DEFAULT

private static final Tracestate TRACESTATE_DEFAULT

SAMPLED_TRACE_OPTIONS

private static final TraceOptions SAMPLED_TRACE_OPTIONS

NOT_SAMPLED_TRACE_OPTIONS

private static final TraceOptions NOT_SAMPLED_TRACE_OPTIONS

options

private final SpanBuilderImpl.Options options

name

private final String name

parent

@Nullable
private final Span parent

remoteParentSpanContext

@Nullable
private final SpanContext remoteParentSpanContext

sampler

@Nullable
private Sampler sampler

parentLinks

private List<Span> parentLinks

recordEvents

@Nullable
private Boolean recordEvents

kind

@Nullable
private Span.Kind kind

Constructor Details

SpanBuilderImpl

private SpanBuilderImpl(String name,
 @Nullable
 SpanContext remoteParentSpanContext,
 @Nullable
 Span parent,
 SpanBuilderImpl.Options options)

Method Details

startSpanInternal

private Span startSpanInternal(@Nullable
 SpanContext parentContext,
 @Nullable
 Boolean hasRemoteParent,
 String name,
 @Nullable
 Sampler sampler,
 List<Span> parentLinks,
 @Nullable
 Boolean recordEvents,
 @Nullable
 Span.Kind kind,
 @Nullable
 Span parentSpan)

makeSamplingDecision

private static boolean makeSamplingDecision(@Nullable
 SpanContext parent,
 @Nullable
 Boolean hasRemoteParent,
 String name,
 @Nullable
 Sampler sampler,
 List<Span> parentLinks,
 TraceId traceId,
 SpanId spanId,
 TraceParams activeTraceParams)

isAnyParentLinkSampled

private static boolean isAnyParentLinkSampled(List<Span> parentLinks)

linkSpans

private static void linkSpans(Span span,
 List<Span> parentLinks)

createWithParent

static SpanBuilderImpl createWithParent(String spanName,
 @Nullable
 Span parent,
 SpanBuilderImpl.Options options)

createWithRemoteParent

static SpanBuilderImpl createWithRemoteParent(String spanName,
 @Nullable
 SpanContext remoteParentSpanContext,
 SpanBuilderImpl.Options options)

startSpan

public Span startSpan()

Description copied from class: SpanBuilder

Starts a new Span.

Users must manually call Span.end() or Span.end(EndSpanOptions) to end this Span.

Does not install the newly created Span to the current Context.

Example of usage:

class MyClass {
  private static final Tracer tracer = Tracing.getTracer();
  void DoWork(Span parent) {
    Span childSpan = tracer.spanBuilderWithExplicitParent("MyChildSpan", parent).startSpan();
    childSpan.addAnnotation("my annotation");
    try {
      doSomeWork(childSpan); // Manually propagate the new span down the stack.
    } finally {
      // To make sure we end the span even in case of an exception.
      childSpan.end();  // Manually end the span.
    }
  }
}

Specified by:

startSpan in class SpanBuilder

Returns:

the newly created Span.

setSampler

public SpanBuilderImpl setSampler(Sampler sampler)

Description copied from class: SpanBuilder

Sets the Sampler to use. If not set, the implementation will provide a default.

Specified by:

setSampler in class SpanBuilder

Parameters:

sampler - the Sampler to use when determining sampling for a Span.

Returns:

this.

setParentLinks

public SpanBuilderImpl setParentLinks(List<Span> parentLinks)

Description copied from class: SpanBuilder

Sets the List of parent links. Links are used to link Spans in different traces. Used (for example) in batching operations, where a single batch handler processes multiple requests from different traces.

Specified by:

setParentLinks in class SpanBuilder

Parameters:

parentLinks - new links to be added.

Returns:

this.

setRecordEvents

public SpanBuilderImpl setRecordEvents(boolean recordEvents)

Description copied from class: SpanBuilder

Sets the option Span.Options.RECORD_EVENTS for the newly created Span. If not called, the implementation will provide a default.

Specified by:

setRecordEvents in class SpanBuilder

Parameters:

recordEvents - new value determining if this Span should have events recorded.

Returns:

this.

setSpanKind

public SpanBuilderImpl setSpanKind(@Nullable
 Span.Kind kind)

Description copied from class: SpanBuilder

Sets the Span.Kind for the newly created Span. If not called, the implementation will provide a default.

Overrides:

setSpanKind in class SpanBuilder

Parameters:

kind - the kind of the newly created Span.

Returns:

this.