Package com.github.kristofa.brave

Class ClientTracer

java.lang.Object

com.github.kristofa.brave.AnnotationSubmitter

com.github.kristofa.brave.ClientTracer

Deprecated.

Replaced by brave.Span with kind=Kind.CLIENT

@Deprecated
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	Description
static class	ClientTracer.Builder	Deprecated. Don't build your own ClientTracer. Use Brave.clientTracer()

Nested classes/interfaces inherited from class com.github.kristofa.brave.AnnotationSubmitter

AnnotationSubmitter.Clock

Method Summary

Modifier and Type	Method	Description
static ClientTracer.Builder	builder()	Deprecated. Don't build your own ClientTracer. Use Brave.clientTracer()
void	setClientReceived()	Deprecated. Sets the 'client received' event for current thread.
void	setClientSent()	Deprecated. Sets 'client sent' event for current thread.
void	setClientSent(int ipv4, int port, java.lang.String serviceName)	Deprecated. use setClientSent(Endpoint)
void	setClientSent(Endpoint server)	Deprecated. Like setClientSent(), except you can log the network context of the destination.
SpanId	startNewSpan(java.lang.String requestName)	Deprecated. 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

@Deprecated
public static ClientTracer.Builder builder()

Deprecated. Don't build your own ClientTracer. Use Brave.clientTracer()

setClientSent

public void setClientSent()

Deprecated.

Sets 'client sent' event for current thread.

setClientSent

public void setClientSent(Endpoint server)

Deprecated.

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

Parameters:

server - represents the server (peer). Set Endpoint.service_name to "unknown" if unknown.

setClientSent

@Deprecated
public void setClientSent(int ipv4,
                          int port,
                          @Nullable
                          java.lang.String serviceName)

Deprecated. use setClientSent(Endpoint)

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()

Deprecated.

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(@Nullable
                           java.lang.String requestName)

Deprecated.

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. Null or empty will defer to the server's name of the operation.

Returns:

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