Package zipkin2.reporter

Class AsyncReporter.Builder

java.lang.Object

zipkin2.reporter.AsyncReporter.Builder

Enclosing class:

AsyncReporter<S>

public static final class AsyncReporter.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
AsyncReporter<zipkin2.Span>	build()	Builds an async reporter that encodes zipkin spans as they are reported.
<S> AsyncReporter<S>	build(zipkin2.codec.BytesEncoder<S> encoder)	Builds an async reporter that encodes arbitrary spans as they are reported.
AsyncReporter.Builder	closeTimeout(long timeout, TimeUnit unit)	How long to block for in-flight spans to send out-of-process on close.
AsyncReporter.Builder	messageMaxBytes(int messageMaxBytes)	Maximum bytes sendable per message including overhead.
AsyncReporter.Builder	messageTimeout(long timeout, TimeUnit unit)	Default 1 second.
AsyncReporter.Builder	metrics(ReporterMetrics metrics)	Aggregates and reports reporter metrics to a monitoring system.
AsyncReporter.Builder	queuedMaxBytes(int queuedMaxBytes)	Maximum backlog of span bytes reported vs sent.
AsyncReporter.Builder	queuedMaxSpans(int queuedMaxSpans)	Maximum backlog of spans reported vs sent.
AsyncReporter.Builder	threadFactory(ThreadFactory threadFactory)	Launches the flush thread when messageTimeoutNanos is greater than zero.

Methods inherited from class java.lang.Object

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

Method Details

threadFactory

public AsyncReporter.Builder threadFactory(ThreadFactory threadFactory)

Launches the flush thread when messageTimeoutNanos is greater than zero.

metrics

public AsyncReporter.Builder metrics(ReporterMetrics metrics)

Aggregates and reports reporter metrics to a monitoring system. Defaults to no-op.

messageMaxBytes

public AsyncReporter.Builder messageMaxBytes(int messageMaxBytes)

Maximum bytes sendable per message including overhead. Defaults to, and is limited by Sender.messageMaxBytes().

messageTimeout

public AsyncReporter.Builder messageTimeout(long timeout, TimeUnit unit)

Default 1 second. 0 implies spans are flushed externally.

Instead of sending one message at a time, spans are bundled into messages, up to Sender.messageMaxBytes(). This timeout ensures that spans are not stuck in an incomplete message.

Note: this timeout starts when the first unsent span is reported.

closeTimeout

public AsyncReporter.Builder closeTimeout(long timeout, TimeUnit unit)

How long to block for in-flight spans to send out-of-process on close. Default 1 second

queuedMaxSpans

public AsyncReporter.Builder queuedMaxSpans(int queuedMaxSpans)

Maximum backlog of spans reported vs sent. Default 10000

queuedMaxBytes

public AsyncReporter.Builder queuedMaxBytes(int queuedMaxBytes)

Maximum backlog of span bytes reported vs sent. Default 1% of heap

build

public AsyncReporter<zipkin2.Span> build()

Builds an async reporter that encodes zipkin spans as they are reported.

build

public <S> AsyncReporter<S> build(zipkin2.codec.BytesEncoder<S> encoder)

Builds an async reporter that encodes arbitrary spans as they are reported.