Package com.github.kristofa.brave

Interface Summary

Interface	Description
ClientRequestAdapter	Adapter used to get tracing information from and add tracing information to a new request.
ClientResponseAdapter
ClientSpanState	Maintains state for a single client span.
CommonSpanState	Keeps track of common trace/span state information.
LocalSpanState	Maintains state for a single local span.
ServerClientAndLocalSpanState	Combines server and client span state.
ServerRequestAdapter	Provides properties needed for dealing with server request.
ServerResponseAdapter
ServerSpanState	Maintains state for a single server span.
SpanAndEndpoint
SpanCollector	Collects spans that are submitted by ServerTracer and ClientTracer.
SpanCollectorMetricsHandler	Monitor SpanCollector by implementing reactions to these events, e.g.
TraceData.Builder
TraceFilter	Deprecated Use Sampler instead.

Class Summary

Class	Description
AbstractSpanCollector	Implemented AbstractSpanCollector.sendSpans(byte[]) to transport a encoded list of spans to Zipkin.
AnnotationSubmitter	Used to submit application specific annotations.
BoundarySampler	This sampler is appropriate for high-traffic instrumentation (ex edge web servers that each receive >100K requests) who provision random trace ids, and make the sampling decision only once.
Brave
Brave.Builder	Builds Brave api objects with following defaults if not overridden:
BraveAnnotations	Deprecated unused; will be removed in Brave 2.0
BraveCallable<T>	Callable implementation that wraps another Callable and makes sure the wrapped Callable will be executed in the same Span/Trace context as the thread from which the Callable was executed.
BraveExecutorService	ExecutorService that wraps around an existing ExecutorService and that makes sure the threads are executed in the same Span/Trace context as the the thread that invoked execution of the threads.
BraveRunnable	Runnable implementation that wraps another Runnable and makes sure the wrapped Runnable will be executed in the same Span/Trace context as the thread from which the Runnable was executed.
ClientRequestInterceptor	Contains logic for handling an outgoing client request.
ClientResponseInterceptor	Contains logic for dealing with response from client request.
ClientSpanThreadBinder	Allows binding span from client request thread to a async callback thread that process the result.
ClientTracer	Low level api that deals with client side of a request: Decide on tracing or not (sampling) Sending client set / client received annotations It is advised that you use ClientRequestInterceptor and ClientResponseInterceptor which build upon ClientTracer and provide a higher level api.
ClientTracer.Builder
CountingSampler	This sampler is appropriate for low-traffic instrumentation (ex servers that each receive <100K requests), or those who do not provision random trace ids.
EmptySpanCollector	A SpanCollector implementation that does nothing with collected spans.
EmptySpanCollectorMetricsHandler	Empty implementation ignoring all events.
FixedSampleRateTraceFilter	Deprecated Use Sampler instead.
FlushingSpanCollector	Extend this class to offload the task of reporting spans to separate thread.
IdConversion	Contains conversion utilities for converting trace and span ids from long to string and vice versa.
KeyValueAnnotation
LocalTracer	Local tracer is designed for in-process activity that explains latency.
LoggingSpanCollector	Simple SpanCollector implementation which logs the span through jul at INFO level.
NoAnnotationsClientResponseAdapter
Sampler	Sampler is responsible for deciding if a particular trace should be "sampled", i.e.
ServerRequestInterceptor	Contains logic for handling an incoming server request.
ServerResponseInterceptor	Contains logic for dealing with response being returned at server side.
ServerSpan	The ServerSpan is initialized by ServerTracer and keeps track of Trace/Span state of our service request.
ServerSpanThreadBinder	Allows binding span from request thread to a new executor thread.
ServerTracer	Used for setting up trace information for a request.
ServerTracer.Builder
SpanAndEndpoint.ClientSpanAndEndpoint
SpanAndEndpoint.LocalSpanAndEndpoint
SpanAndEndpoint.ServerSpanAndEndpoint
SpanAndEndpoint.StaticSpanAndEndpoint	Span and endpoint never change reference.
SpanId	Contains trace data that's propagated in-band across requests, sometimes known as Baggage.
SpanId.Builder
ThreadLocalServerClientAndLocalSpanState	ServerClientAndLocalSpanState implementation that keeps trace state using a ThreadLocal variable.
TraceData	Trace properties we potentially get from incoming request.
TraceKeys	Deprecated use TraceKeys; will be removed in Brave 2.0