brave

Class Tracing.Builder

java.lang.Object

brave.Tracing.Builder

Enclosing class:

Tracing

public static final class Tracing.Builder
extends Object

Method Summary

Modifier and Type	Method and Description
Tracing	build()
Tracing.Builder	clock(Clock clock) See Tracing.clock()
Tracing.Builder	currentTraceContext(CurrentTraceContext currentTraceContext) Responsible for implementing Tracer.currentSpan() and Tracer.withSpanInScope(Span).
Tracing.Builder	localEndpoint(zipkin.Endpoint localEndpoint)
Tracing.Builder	localServiceName(String localServiceName) Controls the name of the service being traced, while still using a default site-local IP.
Tracing.Builder	reporter(zipkin.reporter.Reporter<zipkin.Span> reporter) Controls how spans are reported.
Tracing.Builder	sampler(Sampler sampler) Sampler is responsible for deciding if a particular trace should be "sampled", i.e.
Tracing.Builder	traceId128Bit(boolean traceId128Bit) When true, new root spans will have 128-bit trace IDs.

Methods inherited from class java.lang.Object

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

Method Detail

localServiceName

public Tracing.Builder localServiceName(String localServiceName)

Controls the name of the service being traced, while still using a default site-local IP. This is an alternative to localEndpoint(Endpoint).

Parameters:

localServiceName - name of the service being traced. Defaults to "unknown".

localEndpoint

public Tracing.Builder localEndpoint(zipkin.Endpoint localEndpoint)

Parameters:

localEndpoint - Endpoint of the local service being traced. Defaults to site local.

reporter

public Tracing.Builder reporter(zipkin.reporter.Reporter<zipkin.Span> reporter)

Controls how spans are reported. Defaults to logging, but often an AsyncReporter which batches spans before sending to Zipkin. The AsyncReporter includes a Sender, which is a driver for transports like http, kafka and scribe.

For example, here's how to batch send spans via http:

 reporter = AsyncReporter.create(URLConnectionSender.create("http://localhost:9411/api/v1/spans"));

 tracerBuilder.reporter(reporter);
 

See https://github.com/openzipkin/zipkin-reporter-java

clock

public Tracing.Builder clock(Clock clock)

See Tracing.clock()

sampler

public Tracing.Builder sampler(Sampler sampler)

Sampler is responsible for deciding if a particular trace should be "sampled", i.e. whether the overhead of tracing will occur and/or if a trace will be reported to Zipkin.

currentTraceContext

public Tracing.Builder currentTraceContext(CurrentTraceContext currentTraceContext)

Responsible for implementing Tracer.currentSpan() and Tracer.withSpanInScope(Span). By default a simple thread-local is used. Override to support other mechanisms or to synchronize with other mechanisms such as SLF4J's MDC.

traceId128Bit

public Tracing.Builder traceId128Bit(boolean traceId128Bit)

When true, new root spans will have 128-bit trace IDs. Defaults to false (64-bit)

build

public Tracing build()