Package brave.http

Class HttpTracing

java.lang.Object

brave.http.HttpTracing

All Implemented Interfaces:

Closeable, AutoCloseable

public class HttpTracing
extends Object
implements Closeable

Instances built via create(Tracing) or newBuilder(Tracing) are registered automatically such that statically configured instrumentation like HTTP clients can use current().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	HttpTracing.Builder

Method Summary

Modifier and Type	Method	Description
HttpTracing	clientOf(String serverName)	Scopes this component for a client of the indicated server.
HttpClientParser	clientParser()	Deprecated. Since 5.10, use clientRequestParser() and clientResponseParser()
HttpRequestParser	clientRequestParser()	Used by HttpClientHandler.handleSend(HttpClientRequest) to add a span name and tags about the request before it is sent to the server.
SamplerFunction<HttpRequest>	clientRequestSampler()	Returns an overriding sampling decision for a new trace.
HttpResponseParser	clientResponseParser()	Used by HttpClientHandler.handleReceive(HttpClientResponse, Span) to add tags about the response received from the server.
HttpSampler	clientSampler()	Deprecated. Since 5.8, use clientRequestSampler()
void	close()
static HttpTracing	create(Tracing tracing)
static HttpTracing	current()	Returns the most recently created tracing component iff it hasn't been closed.
static HttpTracing.Builder	newBuilder(Tracing tracing)
String	serverName()	Used by http clients to indicate the name of the destination service.
HttpServerParser	serverParser()	Deprecated. Since 5.10, use serverRequestParser() and serverResponseParser()
HttpRequestParser	serverRequestParser()	Used by HttpServerHandler.handleReceive(HttpServerRequest) to add a span name and tags about the request before the server processes it.
SamplerFunction<HttpRequest>	serverRequestSampler()	Returns an overriding sampling decision for a new trace.
HttpResponseParser	serverResponseParser()	Used by HttpServerHandler.handleSend(Object, Throwable, Span) to add tags about the response sent to the client.
HttpSampler	serverSampler()	Deprecated. Since 5.8, use serverRequestSampler()
HttpTracing.Builder	toBuilder()
Tracing	tracing()

Methods inherited from class java.lang.Object

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

Method Details

create

public static HttpTracing create(Tracing tracing)

newBuilder

public static HttpTracing.Builder newBuilder(Tracing tracing)

tracing

public Tracing tracing()

clientRequestParser

public HttpRequestParser clientRequestParser()

Used by HttpClientHandler.handleSend(HttpClientRequest) to add a span name and tags about the request before it is sent to the server.

Since:

5.10

clientResponseParser

public HttpResponseParser clientResponseParser()

Used by HttpClientHandler.handleReceive(HttpClientResponse, Span) to add tags about the response received from the server.

Since:

5.10

clientParser

@Deprecated public HttpClientParser clientParser()

Deprecated.

Since 5.10, use clientRequestParser() and clientResponseParser()

serverName

public String serverName()

Used by http clients to indicate the name of the destination service. Defaults to "", which will not show in the zipkin UI or end up in the dependency graph.

When present, a link from Tracing.Builder.localServiceName(String) to this name will increment for each traced client call.

As this is endpoint-specific, it is typical to create a scoped instance of HttpTracing to assign this value. For example:

 github = TracingHttpClientBuilder.create(httpTracing.clientOf("github"));
 

See Also:

HttpClientHandler, Span.remoteServiceName(String)

clientOf

public HttpTracing clientOf(String serverName)

Scopes this component for a client of the indicated server.

See Also:

serverName()

serverRequestParser

public HttpRequestParser serverRequestParser()

Used by HttpServerHandler.handleReceive(HttpServerRequest) to add a span name and tags about the request before the server processes it.

Since:

5.10

serverResponseParser

public HttpResponseParser serverResponseParser()

Used by HttpServerHandler.handleSend(Object, Throwable, Span) to add tags about the response sent to the client.

Since:

5.10

serverParser

@Deprecated public HttpServerParser serverParser()

Deprecated.

Since 5.10, use serverRequestParser() and serverResponseParser()

clientSampler

@Deprecated public HttpSampler clientSampler()

Deprecated.

Since 5.8, use clientRequestSampler()

clientRequestSampler

public SamplerFunction<HttpRequest> clientRequestSampler()

Returns an overriding sampling decision for a new trace. Defaults to ignore the request and use the trace ID instead.

This decision happens when a trace was not yet started in process. For example, you may be making an http request as a part of booting your application. You may want to opt-out of tracing client requests that did not originate from a server request.

Since:

5.8

See Also:

SamplerFunctions

serverSampler

@Deprecated public HttpSampler serverSampler()

Deprecated.

Since 5.8, use serverRequestSampler()

serverRequestSampler

public SamplerFunction<HttpRequest> serverRequestSampler()

Returns an overriding sampling decision for a new trace. Defaults to ignore the request and use the trace ID instead.

This decision happens when trace IDs were not in headers, or a sampling decision has not yet been made. For example, if a trace is already in progress, this function is not called. You can implement this to skip paths that you never want to trace.

Since:

5.8

See Also:

SamplerFunctions

toBuilder

public HttpTracing.Builder toBuilder()

current

@Nullable public static HttpTracing current()

Returns the most recently created tracing component iff it hasn't been closed. null otherwise.

This object should not be cached.

Since:

5.9

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Since:

5.9