Package zipkin2.reporter.brave

Class AsyncZipkinSpanHandler

java.lang.Object

brave.handler.SpanHandler

zipkin2.reporter.brave.ZipkinSpanHandler

zipkin2.reporter.brave.AsyncZipkinSpanHandler

All Implemented Interfaces:

Closeable, Flushable, AutoCloseable

public final class AsyncZipkinSpanHandler
extends ZipkinSpanHandler
implements Closeable, Flushable

A SpanHandler that queues spans on ZipkinSpanHandler.end(brave.propagation.TraceContext, brave.handler.MutableSpan, brave.handler.SpanHandler.Cause) to bundle and send as a bulk Zipkin JSON V2 message. When the Sender is HTTP, the endpoint is usually "http://zipkinhost:9411/api/v2/spans".

Example:

 sender = URLConnectionSender.create("http://localhost:9411/api/v2/spans");
 zipkinSpanHandler = AsyncZipkinSpanHandler.create(sender); // don't forget to close!
 tracingBuilder.addSpanHandler(zipkinSpanHandler);
 

Since:

2.14

See Also:

if you need to use a different format, Tracing.Builder.addSpanHandler(SpanHandler)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AsyncZipkinSpanHandler.Builder

Nested classes/interfaces inherited from class brave.handler.SpanHandler

brave.handler.SpanHandler.Cause

Field Summary

Fields inherited from class brave.handler.SpanHandler

NOOP

Method Summary

Modifier and Type	Method	Description
void	close()	Implementations that throw exceptions on close have bugs.
static AsyncZipkinSpanHandler	create(Sender sender)
void	flush()
static AsyncZipkinSpanHandler.Builder	newBuilder(Sender sender)
AsyncZipkinSpanHandler.Builder	toBuilder()	Allows this instance to be reconfigured, for example ZipkinSpanHandler.Builder.alwaysReportSpans(boolean).

Methods inherited from class zipkin2.reporter.brave.ZipkinSpanHandler

create, end, equals, hashCode, newBuilder, toString

Methods inherited from class brave.handler.SpanHandler

begin, handlesAbandoned

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

create

public static AsyncZipkinSpanHandler create(Sender sender)

Since:

2.14

newBuilder

public static AsyncZipkinSpanHandler.Builder newBuilder(Sender sender)

Since:

2.14

toBuilder

public AsyncZipkinSpanHandler.Builder toBuilder()

Description copied from class: ZipkinSpanHandler

Allows this instance to be reconfigured, for example ZipkinSpanHandler.Builder.alwaysReportSpans(boolean).

Note: Call ZipkinSpanHandler.close() if you no longer need this instance, as otherwise it can leak resources.

Overrides:

toBuilder in class ZipkinSpanHandler

flush

public void flush()

Specified by:

flush in interface Flushable

close

public void close()

Description copied from class: ZipkinSpanHandler

Implementations that throw exceptions on close have bugs. This may result in log warnings, though.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Overrides:

close in class ZipkinSpanHandler