Package io.honeycomb.beeline.tracing

Class SpanBuilderFactory.SpanBuilder

java.lang.Object

io.honeycomb.beeline.tracing.SpanBuilderFactory.SpanBuilder

Direct Known Subclasses:

SpanBuilderFactory.NoopSpanBuilder

Enclosing class:

SpanBuilderFactory

public static class SpanBuilderFactory.SpanBuilder
extends Object

Builder to capture various attributes to initialise a Span with.

Some properties are already initialised to defaults, but you may have to provide spanName and serviceName. If traceId or spanId are not configured new random IDs will be generated upon calling build().

Spans are sampled on build(), based on the implementation of the configured TraceSampler.

Thread-safety

Instances of this class are not thread-safe.

Constructor Summary

Constructors

Constructor	Description
SpanBuilder(SpanPostProcessor processor, io.honeycomb.libhoney.transport.batch.ClockProvider clock, TraceIdProvider idProvider, TraceSampler<? super String> traceSampler)

Method Summary

Modifier and Type	Method	Description
SpanBuilderFactory.SpanBuilder	addField(String key, Object value)
SpanBuilderFactory.SpanBuilder	addFields(Map<String,?> fieldsToAdd)
Span	build()	Spans returned by this method are subject to sampling based on their traceId.
io.honeycomb.libhoney.transport.batch.ClockProvider	getClock()
Map<String,Object>	getFields()
PropagationContext	getParentContext()
SpanPostProcessor	getProcessor()
String	getServiceName()
String	getSpanId()
String	getSpanName()
Long	getStartTime()
Long	getTimestamp()
SpanBuilderFactory.SpanBuilder	setParentContext(PropagationContext parentContext)
SpanBuilderFactory.SpanBuilder	setServiceName(String serviceName)
SpanBuilderFactory.SpanBuilder	setSpanId(String spanId)
SpanBuilderFactory.SpanBuilder	setSpanName(String spanName)
SpanBuilderFactory.SpanBuilder	setTimes(long newTimestamp, long newStartTime)

Methods inherited from class java.lang.Object

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

Constructor Detail

SpanBuilder

public SpanBuilder(SpanPostProcessor processor,
                   io.honeycomb.libhoney.transport.batch.ClockProvider clock,
                   TraceIdProvider idProvider,
                   TraceSampler<? super String> traceSampler)

Method Detail

setSpanName

public SpanBuilderFactory.SpanBuilder setSpanName(String spanName)

setServiceName

public SpanBuilderFactory.SpanBuilder setServiceName(String serviceName)

setParentContext

public SpanBuilderFactory.SpanBuilder setParentContext(PropagationContext parentContext)

addField

public SpanBuilderFactory.SpanBuilder addField(String key,
                                               Object value)

addFields

public SpanBuilderFactory.SpanBuilder addFields(Map<String,?> fieldsToAdd)

setTimes

public SpanBuilderFactory.SpanBuilder setTimes(long newTimestamp,
                                               long newStartTime)

setSpanId

public SpanBuilderFactory.SpanBuilder setSpanId(String spanId)

getServiceName

public String getServiceName()

getSpanName

public String getSpanName()

getFields

public Map<String,Object> getFields()

getParentContext

public PropagationContext getParentContext()

getProcessor

public SpanPostProcessor getProcessor()

getTimestamp

public Long getTimestamp()

getStartTime

public Long getStartTime()

getSpanId

public String getSpanId()

getClock

public io.honeycomb.libhoney.transport.batch.ClockProvider getClock()

build

public Span build()

Spans returned by this method are subject to sampling based on their traceId. If the global sampler decides the trace is not to be sampled then it will return a "noop" Span (see Span.isNoop().

If the SpanPostProcessor has been configured with a "sampling hook", then for all Spans on a sampled trace, another sampling decision is taken when they are closed. In other words, the Spans are passed to the sampling hook just before they are about to be sent.

Returns:

an instance of Span with the configured attributes.

Throws:

IllegalArgumentException - if required attributes are not set.