com.github.kristofa.brave

Interface ClientTracer

All Superinterfaces:

AnnotationSubmitter

public interface ClientTracer
extends AnnotationSubmitter

Used by a client that submits a new service request. At the moment the ClientTracer is used we can already be part of a trace/span or we can be the first one to submit a request.

Depending on the implementation it can be that each request is traced or it can be that only some requests are traced to avoid too much overhead. This is all managed in the ClientTracer implementation. The user should not be aware.

Author:

kristof

Method Summary

Methods

Modifier and Type	Method and Description
void	setClientReceived() Sets the 'client received' event for current thread.
void	setClientSent() Sets 'client sent' event for current thread.
void	setCurrentClientServiceName(String serviceName) Override the service name that will be submitted in the annotations.
SpanId	startNewSpan(String requestName) Start a new span for a new client request that will be bound to current thread.

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

submitAnnotation, submitAnnotation, submitBinaryAnnotation, submitBinaryAnnotation

Method Detail

startNewSpan

SpanId startNewSpan(String requestName)

Start a new span for a new client request that will be bound to current thread. The ClientTracer can decide to return null in case this request should not be traced (eg sampling).

Parameters:

requestName - Request name. Should not be null or empty.

Returns:

Span id for new request or null in case we should not trace this new client request.

setCurrentClientServiceName

void setCurrentClientServiceName(String serviceName)

Override the service name that will be submitted in the annotations.

This should be set before submitting any annotations. So after invoking startNewSpan(String) and before setClientSent().

Parameters:

serviceName - should be the same as the name of the service the client is calling.

setClientSent

void setClientSent()

Sets 'client sent' event for current thread.

setClientReceived

void setClientReceived()

Sets the 'client received' event for current thread. This will also submit span because setting a client received event means this span is finished.