com.github.kristofa.brave.ServerSpanThreadBinder Maven / Gradle / Ivy

Go to download
package com.github.kristofa.brave;

import com.twitter.zipkin.gen.Span;

/**
 * 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
 */
public interface ServerSpanThreadBinder {

    /**
     * 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
     * {@link ServerSpanThreadBinder#setCurrentSpan(Span)}.
     * 
     * @see ServerSpanThreadBinder#setCurrentSpan(Span)
     * @return Returned Span can be bound to different executing threads.
     */
    ServerSpan getCurrentServerSpan();

    /**
     * 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.
     * 
     * @param span Span to bind to current execution thread. Should not be null.
     */
    void setCurrentSpan(final ServerSpan span);

}