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 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 and Description
Builder() Builder which initializes with serviceName = "unknown".
Builder(int ip, int port, String serviceName) Builder.
Builder(ServerClientAndLocalSpanState state) Use for control of how tracing state propagates across threads.
Builder(String serviceName) Builder.

Method Summary

Modifier and Type	Method and Description
Brave	build()
Brave.Builder	spanCollector(SpanCollector spanCollector)
Brave.Builder	traceFilters(List<TraceFilter> ignored) Deprecated. use traceSampler(Sampler) as filters here will be ignored.
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(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,
               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(ServerClientAndLocalSpanState state)

Use for control of how tracing state propagates across threads.

Method Detail

traceFilters

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

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

traceSampler

public Brave.Builder traceSampler(Sampler sampler)

spanCollector

public Brave.Builder spanCollector(SpanCollector spanCollector)

Parameters:

spanCollector -

build

public Brave build()