com.github.kristofa.brave

Interface ClientRequestAdapter

public interface ClientRequestAdapter

Adapter used to get tracing information from and add tracing information to a new request.

Method Summary

Modifier and Type	Method and Description
void	addSpanIdToRequest(SpanId spanId) Enrich the request with the Spanid so we pass the state to the service we are calling.
String	getClientServiceName() Returns the service name for request.
String	getSpanName() Gets the span name for request.
Collection<KeyValueAnnotation>	requestAnnotations() Returns a collection of annotations that should be added to span for given request.

Method Detail

getSpanName

String getSpanName()

Gets the span name for request.

Returns:

Span name for request.

addSpanIdToRequest

void addSpanIdToRequest(@Nullable
                        SpanId spanId)

Enrich the request with the Spanid so we pass the state to the service we are calling.

Parameters:

spanId - Nullable span id. If null we don't need to trace request and you should pass an indication along with the request that indicates we won't trace this request.

getClientServiceName

String getClientServiceName()

Returns the service name for request. The service name is expected to be the same as the service we are calling. The service name will be used in the endpoint that we set when submitting annotations.

Returns:

service name.

requestAnnotations

Collection<KeyValueAnnotation> requestAnnotations()

Returns a collection of annotations that should be added to span for given request. Can be used to indicate more details about request next to span name. For example for http requests an annotation containing the uri path could be added.

Returns:

Collection of annotations.