Package io.honeycomb.beeline.tracing.context

Interface TracingContext

All Known Implementing Classes:

ThreadLocalTracingContext

public interface TracingContext

An interface that allows the user to configure how spans in a trace are collected by the Tracer.

In most cases, the ThreadLocalTracingContext will be preferrable, and indeed is the default when no special configuration is given. However, in certain cases (eg. when tracing inside a multi-threaded monolithic application), more complex span tracking may be needed in order to overcome ThreadLocal limitations with long-running thread pools.

See Also:

Tracer

Method Summary

Modifier and Type	Method	Description
Deque<TracerSpan>	get()	Return the stack of spans in the current trace (for this service).
boolean	isEmpty()	Check whether the current Span stack if empty.
TracerSpan	peekFirst()	Grab the latest Span in the current stack without removing it.
TracerSpan	peekLast()	Grab the founding Span in the current stack without removing it.
TracerSpan	pop()	Pop the latest Span off the stack for the current service trace and return it.
void	push(TracerSpan span)	Add a new Span to the current service-scope of the trace.
int	size()	The size of the current span stack

Method Detail

get

Deque<TracerSpan> get()

Return the stack of spans in the current trace (for this service).

Returns:

The current Deque of spans. Never null.

size

int size()

The size of the current span stack

Returns:

int value, zero-to-positive

peekLast

TracerSpan peekLast()

Grab the founding Span in the current stack without removing it.

Returns:

The first Span in this service's trace.

peekFirst

TracerSpan peekFirst()

Grab the latest Span in the current stack without removing it.

Returns:

The first Span in this service's trace.

isEmpty

boolean isEmpty()

Check whether the current Span stack if empty.

Returns:

True if the stack is empty (or missing). False otherwise.

push

void push(TracerSpan span)

Add a new Span to the current service-scope of the trace.

Parameters:

span - The span to add

pop

TracerSpan pop()

Pop the latest Span off the stack for the current service trace and return it.

Returns:

the popped value, in case it's useful for debugging, etc.