com.github.kristofa.brave

Interface SpanCollector

All Known Implementing Classes:

EmptySpanCollector, LoggingSpanCollector

public interface SpanCollector

Collects spans that are submitted by ServerTracer and ClientTracer. We can have implementations that simply log the collected spans or implementations that persist the spans to a database, submit them to a service,...

Author:

kristof

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() Closes and cleans up resources.
void	collect(Span span) Collect span.

Method Detail

collect

void collect(Span span)

Collect span.

Parameters:

span - Span, should not be null.

addDefaultAnnotation

void addDefaultAnnotation(String key,
                          String value)

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.

Parameters:

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

value - Annotation value. Should not be null.

close

void close()

Closes and cleans up resources. After close has been called SpanCollector will probably not be usable anymore.