com.github.kristofa.brave

Class ClientTracer

java.lang.Object

com.github.kristofa.brave.AnnotationSubmitter

com.github.kristofa.brave.ClientTracer

public abstract class ClientTracer
extends AnnotationSubmitter

Low level api that deals with client side of a request:

1. Decide on tracing or not (sampling)
2. Sending client set / client received annotations

It is advised that you use ClientRequestInterceptor and ClientResponseInterceptor which build upon ClientTracer and provide a higher level api.

Author:

kristof

See Also:

ClientRequestInterceptor, ClientResponseInterceptor

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClientTracer.Builder

Method Summary

Modifier and Type	Method and Description
static ClientTracer.Builder	builder()
void	setClientReceived() Sets the 'client received' event for current thread.
void	setClientSent() Sets 'client sent' event for current thread.
void	setClientSent(int ipv4, int port, String serviceName) Like setClientSent(), except you can log the network context of the destination.
SpanId	startNewSpan(String requestName) Start a new span for a new client request that will be bound to current thread.

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

create, submitAnnotation, submitAnnotation, submitBinaryAnnotation, submitBinaryAnnotation

Methods inherited from class java.lang.Object

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

Method Detail

builder

public static ClientTracer.Builder builder()

setClientSent

public void setClientSent()

Sets 'client sent' event for current thread.

setClientSent

public void setClientSent(int ipv4,
                          int port,
                          @Nullable
                          String serviceName)

Like setClientSent(), except you can log the network context of the destination.

Parameters:

ipv4 - ipv4 of the server as an int. Ex for 1.2.3.4, it would be (1 << 24) | (2 << 16) | (3 << 8) | 4

port - listen port the client is connecting to, or 0 if unknown

serviceName - lowercase name of the service being called or null if unknown

setClientReceived

public 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.

startNewSpan

public 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 be lowercase and not null or empty.

Returns:

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