Package io.honeycomb.beeline.tracing.context

Class ThreadLocalTracingContext

java.lang.Object

io.honeycomb.beeline.tracing.context.ThreadLocalTracingContext

All Implemented Interfaces:

TracingContext

public class ThreadLocalTracingContext
extends Object
implements TracingContext

This TracingContext uses a non-static ThreadLocal to store the current tracing stack, which will work under ordinary circumstances to isolate spans associated with a single request from other concurrent requests. Using a non-static ThreadLocal allows for the possibility of having multiple Tracer instances working in the service at the same time, using the same threads, but working on different requests.

Constructor Summary

Constructors

Constructor	Description
ThreadLocalTracingContext()

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadLocalTracingContext

public ThreadLocalTracingContext()

Method Detail

get

public Deque<TracerSpan> get()

Description copied from interface: TracingContext

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

Specified by:

get in interface TracingContext

Returns:

The current Deque of spans. Never null.

size

public int size()

Description copied from interface: TracingContext

The size of the current span stack

Specified by:

size in interface TracingContext

Returns:

int value, zero-to-positive

peekLast

public TracerSpan peekLast()

Description copied from interface: TracingContext

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

Specified by:

peekLast in interface TracingContext

Returns:

The first Span in this service's trace.

peekFirst

public TracerSpan peekFirst()

Description copied from interface: TracingContext

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

Specified by:

peekFirst in interface TracingContext

Returns:

The first Span in this service's trace.

isEmpty

public boolean isEmpty()

Description copied from interface: TracingContext

Check whether the current Span stack if empty.

Specified by:

isEmpty in interface TracingContext

Returns:

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

push

public void push(TracerSpan span)

Description copied from interface: TracingContext

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

Specified by:

push in interface TracingContext

Parameters:

span - The span to add

pop

public TracerSpan pop()

Description copied from interface: TracingContext

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

Specified by:

pop in interface TracingContext

Returns:

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