com.github.kristofa.brave

Interface ServerTracer

All Superinterfaces:

AnnotationSubmitter

public interface ServerTracer
extends AnnotationSubmitter

Used for setting up trace information for a request. When a request is received we typically do this:

1. Detect if we are part of existing trace/span. For example with services doing http requests this can be done by detecting and getting values of http header that reresent trace/span ids.
2. Once detected we submit state using one of 3 following methods depending on the state we are in: ServerTracer#setStateExistingTrace(TraceContext), setStateNoTracing() or setStateUnknown(String).
3. Next we execute setServerReceived() to mark the point in time at which we received the request.
4. Service request executes its logic...
5. Just before sending response we execute setServerSend().

Author:

kristof

Method Summary

Methods

Modifier and Type	Method and Description
void	clearCurrentSpan() Clears current span.
long	getThreadDuration() Gets the thread execution duration for this span.
void	setServerReceived() Sets server received event for current request.
void	setServerSend() Sets the server sent event for current thread.
void	setStateCurrentTrace(long traceId, long spanId, Long parentSpanId, String name) Sets the current Trace/Span state.
void	setStateNoTracing() Sets the current Trace/Span state.
void	setStateUnknown(String spanName) Sets the current Trace/Span state.

Methods inherited from interface com.github.kristofa.brave.AnnotationSubmitter

submitAnnotation, submitAnnotation, submitBinaryAnnotation, submitBinaryAnnotation

Method Detail

clearCurrentSpan

void clearCurrentSpan()

Clears current span.

setStateCurrentTrace

void setStateCurrentTrace(long traceId,
                        long spanId,
                        Long parentSpanId,
                        String name)

Sets the current Trace/Span state. Using this method indicates we are part of an existing trace/span.

Parameters:

traceId - Trace id.

spanId - Span id.

parentSpanId - Parent span id. Can be null.

name - Name should not be empty or null.

See Also:

setStateNoTracing(), setStateUnknown(String)

setStateNoTracing

void setStateNoTracing()

Sets the current Trace/Span state. Using this method indicates that a parent request has decided that we should not trace the current request.

See Also:

ServerTracer#setStateExistingTrace(TraceContext), setStateUnknown(String)

setStateUnknown

void setStateUnknown(String spanName)

Sets the current Trace/Span state. Using this method indicates that we got no information about being part of an existing trace or about the fact that we should not trace the current request. In this case the ServerTracer will decide what to do.

Parameters:

spanName - The name of our current request/span.

setServerReceived

void setServerReceived()

Sets server received event for current request. This should be done after setting state using one of 3 methods ServerTracer#setStateExistingTrace(TraceContext), setStateNoTracing() or setStateUnknown(String).

setServerSend

void setServerSend()

Sets the server sent event for current thread.

getThreadDuration

long getThreadDuration()

Gets the thread execution duration for this span.

Returns:

Thread execution duration for this span.