zipkin2.reporter.brave.ZipkinSpanHandler.Builder

zipkin2.reporter.brave.AsyncZipkinSpanHandler.Builder

Enclosing class:: AsyncZipkinSpanHandler

public static final class AsyncZipkinSpanHandler.Builder
extends ZipkinSpanHandler.Builder

Since:: 2.14

Method Summary

Modifier and Type	Method	Description
`AsyncZipkinSpanHandler.Builder`	`alwaysReportSpans(boolean alwaysReportSpans)`	When true, all spans `sampled locally` are reported to the span reporter, even if they aren't sampled remotely.
`AsyncZipkinSpanHandler`	`build()`
`AsyncZipkinSpanHandler.Builder`	`closeTimeout(long timeout, TimeUnit unit)`
`AsyncZipkinSpanHandler.Builder`	`errorTag(brave.Tag<Throwable> errorTag)`	Sets the "error" tag when absent and `MutableSpan.error()` is present.
`AsyncZipkinSpanHandler.Builder`	`messageMaxBytes(int messageMaxBytes)`
`AsyncZipkinSpanHandler.Builder`	`messageTimeout(long timeout, TimeUnit unit)`
`AsyncZipkinSpanHandler.Builder`	`metrics(ReporterMetrics metrics)`
`AsyncZipkinSpanHandler.Builder`	`queuedMaxBytes(int queuedMaxBytes)`
`AsyncZipkinSpanHandler.Builder`	`queuedMaxSpans(int queuedMaxSpans)`
`AsyncZipkinSpanHandler.Builder`	`threadFactory(ThreadFactory threadFactory)`

Methods inherited from class java.lang.Object

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

Method Details
- threadFactory
  
  public AsyncZipkinSpanHandler.Builder threadFactory(ThreadFactory threadFactory)
  
  Since:
  
  2.14
  
  See Also:
  
  AsyncReporter.Builder.threadFactory(ThreadFactory)
- metrics
  
  public AsyncZipkinSpanHandler.Builder metrics(ReporterMetrics metrics)
  
  Since:
  
  2.14
  
  See Also:
  
  AsyncReporter.Builder.metrics(ReporterMetrics)
- messageMaxBytes
  
  public AsyncZipkinSpanHandler.Builder messageMaxBytes(int messageMaxBytes)
  
  Since:
  
  2.14
  
  See Also:
  
  AsyncReporter.Builder.messageMaxBytes(int)
- messageTimeout
  
  public AsyncZipkinSpanHandler.Builder messageTimeout(long timeout, TimeUnit unit)
  
  Since:
  
  2.14
  
  See Also:
  
  AsyncReporter.Builder.messageTimeout(long, TimeUnit)
- closeTimeout
  
  public AsyncZipkinSpanHandler.Builder closeTimeout(long timeout, TimeUnit unit)
  
  Since:
  
  2.14
  
  See Also:
  
  AsyncReporter.Builder.closeTimeout(long, TimeUnit)
- queuedMaxSpans
  
  public AsyncZipkinSpanHandler.Builder queuedMaxSpans(int queuedMaxSpans)
  
  Since:
  
  2.14
  
  See Also:
  
  AsyncReporter.Builder.queuedMaxSpans(int)
- queuedMaxBytes
  
  public AsyncZipkinSpanHandler.Builder queuedMaxBytes(int queuedMaxBytes)
  
  Since:
  
  2.14
  
  See Also:
  
  AsyncReporter.Builder.queuedMaxBytes(int)
- errorTag
  
  public AsyncZipkinSpanHandler.Builder errorTag(brave.Tag<Throwable> errorTag)
  
  Description copied from class: ZipkinSpanHandler.Builder
  
  Sets the "error" tag when absent and MutableSpan.error() is present.
  Note: Zipkin format uses the "error" tag, but alternative formats may have a different tag name or a field entirely. Hence, we only create the "error" tag here, and only if not previously set.
  
  Overrides:
  
  errorTag in class ZipkinSpanHandler.Builder
- alwaysReportSpans
  
  public AsyncZipkinSpanHandler.Builder alwaysReportSpans(boolean alwaysReportSpans)
  
  Description copied from class: ZipkinSpanHandler.Builder
  
  When true, all spans sampled locally are reported to the span reporter, even if they aren't sampled remotely. Defaults to false.
  The primary use case is to implement a sampling overlay, such as boosting the sample rate for a subset of the network depending on the value of a baggage field. This means that data will report when either the trace is normally sampled, or secondarily sampled via a custom header.
  This is simpler than a custom SpanHandler, because you don't have to duplicate transport mechanics already implemented in the span reporter. However, this assumes your backend can properly process the partial traces implied when using conditional sampling. For example, if your sampling condition is not consistent on a call tree, the resulting data could appear broken.
  
  Overrides:
  
  alwaysReportSpans in class ZipkinSpanHandler.Builder
  
  See Also:
  
  SamplingFlags.sampledLocal()
- build
  
  public AsyncZipkinSpanHandler build()
  
  Specified by:
  
  build in class ZipkinSpanHandler.Builder

Class AsyncZipkinSpanHandler.Builder

Method Summary

Methods inherited from class java.lang.Object

Method Details