Package io.honeycomb.beeline.tracing

Class SpanBuilderFactory

java.lang.Object

io.honeycomb.beeline.tracing.SpanBuilderFactory

public class SpanBuilderFactory
extends Object

Sampling

See the Beeline javadoc for details on sampling.

Thread-safety

Instances of this class are thread-safe and can be shared. The SpanBuilder that it creates is not.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SpanBuilderFactory.NoopSpanBuilder
static class	SpanBuilderFactory.SpanBuilder	Builder to capture various attributes to initialise a Span with.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
SpanBuilderFactory.SpanBuilder	createBuilder()	Creates a SpanBuilder instance that allows the customisation of Spans with various attributes.
SpanBuilderFactory.SpanBuilder	createBuilderFrom(Span originalSpan)	Creates a SpanBuilder instance initialised with attributes from the originalSpan argument, which then allows the attributes to be overwritten.
SpanBuilderFactory.SpanBuilder	createBuilderFromParent(Span parentSpan)	Creates a Span builder instance initialised so it forms a child-parent relationship with parentSpan argument.
String	generateId()
io.honeycomb.libhoney.transport.batch.ClockProvider	getClock()
SpanPostProcessor	getProcessor()
TraceSampler<? super String>	getSampler()

Methods inherited from class java.lang.Object

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

Constructor Detail

SpanBuilderFactory

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

Method Detail

createBuilder

public SpanBuilderFactory.SpanBuilder createBuilder()

Creates a SpanBuilder instance that allows the customisation of Spans with various attributes. This method is useful when Spans need to be handled manually, typically for custom framework instrumentation.

The returned builder must be configured with at least:

• spanName
• serviceName

Returns:

a new Span.

createBuilderFrom

public SpanBuilderFactory.SpanBuilder createBuilderFrom(Span originalSpan)

Creates a SpanBuilder instance initialised with attributes from the originalSpan argument, which then allows the attributes to be overwritten. This method is useful when Spans need to be handled manually, typically for custom framework instrumentation.

The returned builder can be built immediately without having to set any properties.

Parameters:

originalSpan - to copy attributes from

Returns:

a new Span as a copy of the originalSpan.

createBuilderFromParent

public SpanBuilderFactory.SpanBuilder createBuilderFromParent(Span parentSpan)

Creates a Span builder instance initialised so it forms a child-parent relationship with parentSpan argument. This method is useful when Spans need to be handled manually, typically for custom framework instrumentation.

The returned builder must be configured with at least:

• spanName

Parameters:

parentSpan - to link to the

Returns:

a new child Span.

generateId

public String generateId()

getProcessor

public SpanPostProcessor getProcessor()

getClock

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

getSampler

public TraceSampler<? super String> getSampler()