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	setSender(zipkin2.reporter.Sender sender)	Sets the Zipkin sender.
ZipkinSpanExporterBuilder	setServiceName(String serviceName)	Deprecated. The default service name is now extracted from the default Resource.

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

setServiceName

@Deprecated
public ZipkinSpanExporterBuilder setServiceName(String serviceName)

Deprecated.

The default service name is now extracted from the default Resource. This method will be removed in the next release.

Label of the remote node in the service graph, such as "favstar". Avoid names with variables or unique identifiers embedded. Defaults to the service.name specified in the default Resource.

This is a primary label for trace lookup and aggregation, so it should be intuitive and consistent. Many use a name from service discovery.

Note: this value, will be superseded by the value of ResourceAttributes.SERVICE_NAME if it has been set in the Resource associated with the Tracer that created the spans.

Parameters:

serviceName - The service name. It defaults to "unknown".

Returns:

this.

See Also:

Resource, ResourceAttributes

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

build

public ZipkinSpanExporter build()

Builds a ZipkinSpanExporter.

Returns:

a ZipkinSpanExporter.