com.github.kristofa.brave

Class FlushingSpanCollector

java.lang.Object

com.github.kristofa.brave.FlushingSpanCollector

All Implemented Interfaces:

SpanCollector, Closeable, Flushable, AutoCloseable

Direct Known Subclasses:

AbstractSpanCollector

public abstract class FlushingSpanCollector
extends Object
implements SpanCollector, Flushable, Closeable

Extend this class to offload the task of reporting spans to separate thread. By doing so, callers are protected from latency or exceptions possible when exporting spans out of process.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	FlushingSpanCollector(SpanCollectorMetricsHandler metrics, int flushInterval)

Method Summary

Modifier and Type	Method and Description
void	addDefaultAnnotation(String key, String value) Adds a fixed annotation that will be added to every span that is submitted to this collector.
void	close() Requests a cease of delivery.
void	collect(Span span) Queues the span for collection, or drops it if the queue is full.
void	flush() Calling this will flush any pending spans to the transport on the current thread.
protected abstract void	reportSpans(List<Span> drained) Reports a list of spans over the current transport.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlushingSpanCollector

protected FlushingSpanCollector(SpanCollectorMetricsHandler metrics,
                                int flushInterval)

Parameters:

flushInterval - in seconds. 0 implies spans are {@link #flush() flushed externally.

Method Detail

collect

public void collect(Span span)

Queues the span for collection, or drops it if the queue is full.

Specified by:

collect in interface SpanCollector

Parameters:

span - Span, should not be null.

flush

public void flush()

Calling this will flush any pending spans to the transport on the current thread.

Specified by:

flush in interface Flushable

reportSpans

protected abstract void reportSpans(List<Span> drained)
                             throws IOException

Reports a list of spans over the current transport.

Throws:

IOException - (or RuntimeException) when thrown, drop metrics will increment accordingly

addDefaultAnnotation

public void addDefaultAnnotation(String key,
                                 String value)

Description copied from interface: SpanCollector

Adds a fixed annotation that will be added to every span that is submitted to this collector.

One use case for this is to distinguish spans from different environments or for testing reasons.

Specified by:

addDefaultAnnotation in interface SpanCollector

Parameters:

key - Annotation name/key. Should not be empty or null.

value - Annotation value. Should not be null.

close

public void close()

Requests a cease of delivery. There will be at most one in-flight send after this call.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable