Package com.github.kristofa.brave

Class ThreadLocalServerClientAndLocalSpanState

java.lang.Object

com.github.kristofa.brave.ThreadLocalServerClientAndLocalSpanState

All Implemented Interfaces:

ClientSpanState, CommonSpanState, LocalSpanState, ServerClientAndLocalSpanState, ServerSpanState

public final class ThreadLocalServerClientAndLocalSpanState
extends java.lang.Object
implements ServerClientAndLocalSpanState

ServerClientAndLocalSpanState implementation that keeps trace state using a ThreadLocal variable.

Author:

kristof

Constructor Summary

Constructors

Constructor	Description
ThreadLocalServerClientAndLocalSpanState(int ip, int port, java.lang.String serviceName)	Constructor
ThreadLocalServerClientAndLocalSpanState(Endpoint endpoint)
ThreadLocalServerClientAndLocalSpanState(java.net.InetAddress ip, int port, java.lang.String serviceName)	Deprecated. Please switch to constructor that takes 'int' for ip. This only does a conversion from the InetAddress to integer anyway and using InetAddress can result in ns lookup and nasty side effects.

Method Summary

Modifier and Type	Method	Description
static void	clear()
Endpoint	endpoint()	Gets the Endpoint (ip, port, service name) for this service.
Span	getCurrentClientSpan()	Gets the Span for the client request that was started as part of current request.
Span	getCurrentLocalSpan()	Gets the Span for the local request that was started as part of current request.
ServerSpan	getCurrentServerSpan()	Never returns null: setCurrentServerSpan(null) coerces to ServerSpan.EMPTY
java.lang.Boolean	sample()
void	setCurrentClientSpan(Span span)	Sets current client span.
void	setCurrentLocalSpan(Span span)	Sets current local span.
void	setCurrentServerSpan(ServerSpan span)	Set span for current request.

Methods inherited from class java.lang.Object

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

Constructor Detail

ThreadLocalServerClientAndLocalSpanState

@Deprecated
public ThreadLocalServerClientAndLocalSpanState(java.net.InetAddress ip,
                                                int port,
                                                java.lang.String serviceName)

Deprecated. Please switch to constructor that takes 'int' for ip. This only does a conversion from the InetAddress to integer anyway and using InetAddress can result in ns lookup and nasty side effects.

Constructor

Parameters:

ip - InetAddress of current host. If you don't have access to InetAddress you can use InetAddressUtilities#getLocalHostLANAddress()

port - port on which current process is listening.

serviceName - Name of the local service being traced. Should be lowercase and not null or empty.

ThreadLocalServerClientAndLocalSpanState

public ThreadLocalServerClientAndLocalSpanState(int ip,
                                                int port,
                                                java.lang.String serviceName)

Constructor

Parameters:

ip - Int representation of ipv4 address.

port - port on which current process is listening.

serviceName - Name of the local service being traced. Should be lowercase and not null or empty.

ThreadLocalServerClientAndLocalSpanState

public ThreadLocalServerClientAndLocalSpanState(Endpoint endpoint)

Parameters:

endpoint - Endpoint of the local service being traced.

Method Detail

clear

public static void clear()

getCurrentServerSpan

public ServerSpan getCurrentServerSpan()

Never returns null: setCurrentServerSpan(null) coerces to ServerSpan.EMPTY

Specified by:

getCurrentServerSpan in interface ServerSpanState

Returns:

Server request span for current thread. This will return the span we are part of. In case we should not trace current request null will be returned.

setCurrentServerSpan

public void setCurrentServerSpan(@Nullable
                                 ServerSpan span)

Set span for current request.

Specified by:

setCurrentServerSpan in interface ServerSpanState

Parameters:

span - Span for current request.

endpoint

public Endpoint endpoint()

Gets the Endpoint (ip, port, service name) for this service.

Specified by:

endpoint in interface CommonSpanState

Returns:

Endpoint for this service.

getCurrentClientSpan

@Nullable
public Span getCurrentClientSpan()

Gets the Span for the client request that was started as part of current request.

Should be thread-aware to support multiple parallel requests.

Specified by:

getCurrentClientSpan in interface ClientSpanState

Returns:

Client request span for current thread.

setCurrentClientSpan

public void setCurrentClientSpan(@Nullable
                                 Span span)

Sets current client span.

Should be thread-aware to support multiple parallel requests.

Specified by:

setCurrentClientSpan in interface ClientSpanState

Parameters:

span - Client span.

sample

@Nullable
public java.lang.Boolean sample()

Specified by:

sample in interface CommonSpanState

getCurrentLocalSpan

@Nullable
public Span getCurrentLocalSpan()

Description copied from interface: LocalSpanState

Gets the Span for the local request that was started as part of current request.

Should be thread-aware to support multiple parallel requests.

Specified by:

getCurrentLocalSpan in interface LocalSpanState

Returns:

Local request span for current thread.

setCurrentLocalSpan

public void setCurrentLocalSpan(@Nullable
                                Span span)

Description copied from interface: LocalSpanState

Sets current local span.

Should be thread-aware to support multiple parallel requests.

Specified by:

setCurrentLocalSpan in interface LocalSpanState

Parameters:

span - Local span.