Package zipkin2.reporter.brave

Class AsyncZipkinSpanHandler

java.lang.Object

brave.handler.SpanHandler

zipkin2.reporter.brave.AsyncZipkinSpanHandler

All Implemented Interfaces:

Closeable, Flushable

public final class AsyncZipkinSpanHandler
extends brave.handler.SpanHandler
implements Closeable, Flushable

A SpanHandler that queues spans on end(brave.propagation.TraceContext, brave.handler.MutableSpan, brave.handler.SpanHandler.Cause) to bundle and send as a bulk Zipkin JSON V2 message. When the BytesMessageSender 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(zipkin2.reporter.BytesMessageSender sender)
static AsyncZipkinSpanHandler	create(zipkin2.reporter.Sender sender)	Deprecated. Since 3.2, use create(BytesMessageSender)
boolean	end(brave.propagation.TraceContext context, brave.handler.MutableSpan span, brave.handler.SpanHandler.Cause cause)
boolean	equals(Object o)	Overridden to avoid duplicates when added via Tracing.Builder.addSpanHandler(SpanHandler)
void	flush()
int	hashCode()	Overridden to avoid duplicates when added via Tracing.Builder.addSpanHandler(SpanHandler)
static AsyncZipkinSpanHandler.Builder	newBuilder(zipkin2.reporter.BytesMessageSender sender)
static AsyncZipkinSpanHandler.Builder	newBuilder(zipkin2.reporter.Sender sender)	Deprecated. Since 3.2, use newBuilder(BytesMessageSender)
AsyncZipkinSpanHandler.Builder	toBuilder()	Allows this instance to be reconfigured, for example ZipkinSpanHandler.Builder.alwaysReportSpans(boolean).
String	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 Detail

create

@Deprecated
public static AsyncZipkinSpanHandler create(zipkin2.reporter.Sender sender)

Deprecated.

Since 3.2, use create(BytesMessageSender)

create

public static AsyncZipkinSpanHandler create(zipkin2.reporter.BytesMessageSender sender)

Since:

3.2

newBuilder

@Deprecated
public static AsyncZipkinSpanHandler.Builder newBuilder(zipkin2.reporter.Sender sender)

Deprecated.

Since 3.2, use newBuilder(BytesMessageSender)

newBuilder

public static AsyncZipkinSpanHandler.Builder newBuilder(zipkin2.reporter.BytesMessageSender sender)

Since:

3.2

toBuilder

public AsyncZipkinSpanHandler.Builder toBuilder()

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

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

Since:

2.15

flush

public void flush()

Specified by:

flush in interface Flushable

close

public void close()

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

Specified by:

close in interface Closeable

Since:

2.15

end

public boolean end(brave.propagation.TraceContext context,
                   brave.handler.MutableSpan span,
                   brave.handler.SpanHandler.Cause cause)

Overrides:

end in class brave.handler.SpanHandler

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Overridden to avoid duplicates when added via Tracing.Builder.addSpanHandler(SpanHandler)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overridden to avoid duplicates when added via Tracing.Builder.addSpanHandler(SpanHandler)

Overrides:

hashCode in class Object