Package io.opentelemetry.exporter.zipkin

Class ZipkinSpanExporterBuilder

java.lang.Object

io.opentelemetry.exporter.zipkin.ZipkinSpanExporterBuilder

public final class ZipkinSpanExporterBuilder
extends Object

Builder class for ZipkinSpanExporter.

Constructor Summary

Constructors

Constructor	Description
ZipkinSpanExporterBuilder()

Method Summary

Modifier and Type	Method	Description
ZipkinSpanExporter	build()	Builds a ZipkinSpanExporter.
ZipkinSpanExporterBuilder	setEncoder(zipkin2.codec.BytesEncoder<zipkin2.Span> encoder)	Sets the BytesEncoder, which controls the format used by the Sender.
ZipkinSpanExporterBuilder	setEndpoint(String endpoint)	Sets the zipkin endpoint.
ZipkinSpanExporterBuilder	setReadTimeout(long timeout, TimeUnit unit)	Sets the maximum time to wait for the export of a batch of spans.
ZipkinSpanExporterBuilder	setReadTimeout(Duration timeout)	Sets the maximum time to wait for the export of a batch of spans.
ZipkinSpanExporterBuilder	setSender(zipkin2.reporter.Sender sender)	Sets the Zipkin sender.

Methods inherited from class java.lang.Object

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

Constructor Detail

ZipkinSpanExporterBuilder

public ZipkinSpanExporterBuilder()

Method Detail

setSender

public ZipkinSpanExporterBuilder setSender(zipkin2.reporter.Sender sender)

Sets the Zipkin sender. Implements the client side of the span transport. A OkHttpSender is a good default.

The Component.close() method will be called when the exporter is shut down.

Parameters:

sender - the Zipkin sender implementation.

Returns:

this.

setEncoder

public ZipkinSpanExporterBuilder setEncoder(zipkin2.codec.BytesEncoder<zipkin2.Span> encoder)

Sets the BytesEncoder, which controls the format used by the Sender. Defaults to the SpanBytesEncoder.JSON_V2.

Parameters:

encoder - the BytesEncoder to use.

Returns:

this.

See Also:

SpanBytesEncoder

setEndpoint

public ZipkinSpanExporterBuilder setEndpoint(String endpoint)

Sets the zipkin endpoint. This will use the endpoint to assign a OkHttpSender instance to this builder.

Parameters:

endpoint - The Zipkin endpoint URL, ex. "http://zipkinhost:9411/api/v2/spans".

Returns:

this.

See Also:

OkHttpSender

setReadTimeout

public ZipkinSpanExporterBuilder setReadTimeout(long timeout,
                                                TimeUnit unit)

Sets the maximum time to wait for the export of a batch of spans. If unset, defaults to 10s.

Returns:

this.

Since:

1.2.0

setReadTimeout

public ZipkinSpanExporterBuilder setReadTimeout(Duration timeout)

Sets the maximum time to wait for the export of a batch of spans. If unset, defaults to 10s.

Returns:

this.

Since:

1.2.0

build

public ZipkinSpanExporter build()

Builds a ZipkinSpanExporter.

Returns:

a ZipkinSpanExporter.