com.github.kristofa.brave

Interface ClientSpanState

All Superinterfaces:

CommonSpanState

All Known Subinterfaces:

ServerClientAndLocalSpanState

All Known Implementing Classes:

ThreadLocalServerClientAndLocalSpanState

public interface ClientSpanState
extends CommonSpanState

Maintains state for a single client span.

Client spans can be at the following locations in the span tree.

• The root-span of a trace originated by Brave
• A child of a server span originated by Brave
• A child of a local span originated by Brave

Author:

kristof

Method Summary

Modifier and Type	Method and Description
Endpoint	getClientEndpoint() 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.
void	setCurrentClientServiceName(String serviceName)
void	setCurrentClientSpan(Span span) Sets current client span.

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

sample

Method Detail

getCurrentClientSpan

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.

Returns:

Client request span for current thread.

getClientEndpoint

Endpoint getClientEndpoint()

Gets the Endpoint (ip, port, service name) for this service. Service name might have been overridden. Should be thread-aware to the service name can be overridden per request.

Returns:

Endpoint for this service.

setCurrentClientSpan

void setCurrentClientSpan(Span span)

Sets current client span.

Should be thread-aware to support multiple parallel requests.

Parameters:

span - Client span.

setCurrentClientServiceName

void setCurrentClientServiceName(@Nullable
                                 String serviceName)

Parameters:

serviceName - Name of the local service being traced. If specified, should be lowercase and not empty.