Package com.github.kristofa.brave

Class Brave.Builder

java.lang.Object

com.github.kristofa.brave.Brave.Builder

Enclosing class:

Brave

public static class Brave.Builder
extends java.lang.Object

Builds Brave api objects with following defaults if not overridden:

• ThreadLocalServerClientAndLocalSpanState which binds trace/span state to current thread.
• LoggingSpanCollector
• Sampler that samples all traces

Constructor Summary

Constructors

Constructor	Description
Builder()	Builder which initializes with serviceName = "unknown".
Builder(int ip, int port, java.lang.String serviceName)	Builder.
Builder(ServerClientAndLocalSpanState state)	Use for control of how tracing state propagates across threads.
Builder(Endpoint endpoint)
Builder(java.lang.String serviceName)	Builder.

Method Summary

Modifier and Type	Method	Description
Brave	build()
Brave.Builder	clock(AnnotationSubmitter.Clock clock)
Brave.Builder	reporter(zipkin.reporter.Reporter<zipkin.Span> reporter)	Deprecated. use spanReporter(Reporter)
Brave.Builder	spanCollector(SpanCollector spanCollector)	Deprecated. use spanReporter(Reporter)
Brave.Builder	spanReporter(zipkin2.reporter.Reporter<zipkin2.Span> reporter)	Controls how spans are reported.
Brave.Builder	supportsJoin(boolean supportsJoin)	True means the tracing system supports sharing a span ID on ServerTracer.setStateCurrentTrace(long, long, java.lang.Long, java.lang.String).
Brave.Builder	traceFilters(java.util.List<TraceFilter> ignored)	Deprecated. use traceSampler(Sampler) as filters here will be ignored.
Brave.Builder	traceId128Bit(boolean traceId128Bit)	When true, new root spans will have 128-bit trace IDs.
Brave.Builder	traceSampler(Sampler sampler)

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Builder which initializes with serviceName = "unknown".

When using this builder constructor we will try to 'guess' ip address by using java.net.* utility classes. This might be convenient but not necessary what you want. It is preferred to use constructor that takes ip, port and service name instead.

Builder

public Builder(java.lang.String serviceName)

Builder.

When using this builder constructor we will try to 'guess' ip address by using java.net.* utility classes. This might be convenient but not necessary what you want. It is preferred to use constructor that takes ip, port and service name instead.

Parameters:

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

Builder

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

Builder.

Parameters:

ip - ipv4 host address as int. Ex for the ip 1.2.3.4, it would be (1 << 24) | (2 << 16) | (3 << 8) | 4

port - Port for service

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

Builder

public Builder(Endpoint endpoint)

Parameters:

endpoint - Endpoint of the local service being traced.

Builder

public Builder(ServerClientAndLocalSpanState state)

Use for control of how tracing state propagates across threads.

Method Detail

traceFilters

@Deprecated
public Brave.Builder traceFilters(java.util.List<TraceFilter> ignored)

Deprecated. use traceSampler(Sampler) as filters here will be ignored.

traceSampler

public Brave.Builder traceSampler(Sampler sampler)

spanReporter

public Brave.Builder spanReporter(zipkin2.reporter.Reporter<zipkin2.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:

 spanReporter = AsyncReporter.create(URLConnectionSender.create("http://localhost:9411/api/v2/spans"));
 braveBuilder.spanReporter(spanReporter);
 

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

reporter

@Deprecated
public Brave.Builder reporter(zipkin.reporter.Reporter<zipkin.Span> reporter)

Deprecated. use spanReporter(Reporter)

spanCollector

@Deprecated
public Brave.Builder spanCollector(SpanCollector spanCollector)

Deprecated. use spanReporter(Reporter)

clock

public Brave.Builder clock(AnnotationSubmitter.Clock clock)

traceId128Bit

public Brave.Builder traceId128Bit(boolean traceId128Bit)

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

supportsJoin

public Brave.Builder supportsJoin(boolean supportsJoin)

True means the tracing system supports sharing a span ID on ServerTracer.setStateCurrentTrace(long, long, java.lang.Long, java.lang.String). Defaults to true.

build

public Brave build()