com.github.kristofa.brave

Class ServerSpanThreadBinder

java.lang.Object

com.github.kristofa.brave.ServerSpanThreadBinder

public class ServerSpanThreadBinder
extends Object

Allows binding span from request thread to a new executor thread.

To be used in case you execute logic in new threads within you service and if you submit annotations or new requests from those threads. The span state is bound to the request thread. When you start new threads it means that the span state that was set in the request thread is not available in those new threads. The ServerSpanThreadBinder allows you to bind the original span state to the new thread.

Author:

kristof

Constructor Summary

Constructors

Constructor and Description
ServerSpanThreadBinder(ServerSpanState state) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
ServerSpan	getCurrentServerSpan() This should be called in the thread in which the request was received before executing code in new threads.
void	setCurrentSpan(ServerSpan span) Binds given span to current thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServerSpanThreadBinder

public ServerSpanThreadBinder(ServerSpanState state)

Creates a new instance.

Parameters:

state - Server span state, should not be null

Method Detail

getCurrentServerSpan

@Nullable
public ServerSpan getCurrentServerSpan()

This should be called in the thread in which the request was received before executing code in new threads.

It returns the current server span which you can keep and bind to a new thread using setCurrentSpan(ServerSpan).

Returns:

Returned Span can be bound to different executing threads.

See Also:

setCurrentSpan(ServerSpan)

setCurrentSpan

public void setCurrentSpan(ServerSpan span)

Binds given span to current thread. This should typically be called when code is invoked in new thread to bind the span from the thread in which we received the request to the new execution thread.

Parameters:

span - Span to bind to current execution thread. Should not be null.