AsyncReporter (Zipkin Reporter: Core 3.0.1 API)

java.lang.Object
- zipkin2.reporter.Component
- - zipkin2.reporter.AsyncReporter<S>

Type Parameters:

S - type of the span, usually Span

All Implemented Interfaces:

Closeable, Flushable, Reporter<S>
```
public class AsyncReporter<S>
extends Component
implements Reporter<S>, Flushable
```
As spans are reported, they are encoded and added to a pending queue. The task of sending spans happens on a separate thread which calls flush(). By doing so, callers are protected from latency or exceptions possible when exporting spans out of process.
Spans are bundled into messages based on size in bytes or a timeout, whichever happens first.
The thread that sends flushes spans to the Sender does so in a synchronous loop. This means that even asynchronous transports will wait for an ack before sending a next message. We do this so that a surge of spans doesn't overrun memory or bandwidth via hundreds or thousands of in-flight messages. The downside of this is that reporting is limited in speed to what a single thread can clear. When a thread cannot clear the backlog, new spans are dropped.

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class AsyncReporter.Builder

Field Summary
- Fields inherited from interface zipkin2.reporter.Reporter
  CONSOLE, NOOP

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static AsyncReporter.Builder`	`builder(Sender sender)`	Like `create(Sender)`, except you can configure settings such as the timeout.
`void`	`close()`	Shuts down the sender thread, and increments drop metrics if there were any unsent spans.
`static AsyncReporter<zipkin2.Span>`	`create(Sender sender)`	Builds a json reporter for Zipkin V2.
`void`	`flush()`	Calling this will flush any pending spans to the transport on the current thread.
`void`	`report(S span)`	Schedules the span to be sent onto the transport.
`String`	`toString()`

Methods inherited from class zipkin2.reporter.Component
check

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - create
```
public static AsyncReporter<zipkin2.Span> create(Sender sender)
```
    Builds a json reporter for Zipkin V2. If http, the endpoint of the sender is usually "http://zipkinhost:9411/api/v2/spans".
    After a certain threshold, spans are drained and sent to Zipkin collectors.
  - builder
```
public static AsyncReporter.Builder builder(Sender sender)
```
    Like create(Sender), except you can configure settings such as the timeout.
  - report
```
public void report(S span)
```
    Description copied from interface: Reporter
    
    Schedules the span to be sent onto the transport.
    
    Specified by:
    
    report in interface Reporter<S>
    
    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.
    Note: If you set message timeout to zero, you must call this externally as otherwise spans will never be sent.
    
    Specified by:
    
    flush in interface Flushable
    
    Throws:
    
    IllegalStateException - if closed
  - close
```
public void close()
```
    Shuts down the sender thread, and increments drop metrics if there were any unsent spans.
    
    Specified by:
    
    close in interface Closeable
    
    Overrides:
    
    close in class Component
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object