Package io.helidon.webserver.zipkin

Class ZipkinTracerBuilder

java.lang.Object

io.helidon.webserver.zipkin.ZipkinTracerBuilder

All Implemented Interfaces:

Builder<io.opentracing.Tracer>

public class ZipkinTracerBuilder
extends Object
implements Builder<io.opentracing.Tracer>

The ZipkinTracerBuilder is a convenience builder for Tracer to use with Zipkin.

See Also:

Zipkin Attributes, Zipkin Missing Service Name

Method Summary

Modifier and Type	Method	Description
io.opentracing.Tracer	build()	Builds the Tracer for Zipkin based on the configured parameters.
static ZipkinTracerBuilder	forService(String serviceName)	Get a Zipkin Tracer builder for processing tracing data of a service with a given name.
ZipkinTracerBuilder	sender(zipkin2.reporter.Sender sender)	The sender to use for sending events to Zipkin.
ZipkinTracerBuilder	zipkin(String endpoint)	Set the Zipkin endpoint address.
ZipkinTracerBuilder	zipkin(URI endpoint)	Set the Zipkin endpoint address.
ZipkinTracerBuilder	zipkinHost(String hostName)	Set the Zipkin host name.

Methods inherited from class java.lang.Object

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

Method Detail

forService

public static ZipkinTracerBuilder forService(String serviceName)

Get a Zipkin Tracer builder for processing tracing data of a service with a given name.

Parameters:

serviceName - name of the service that will be using the tracer.

Returns:

Tracer builder for Zipkin.

zipkin

public ZipkinTracerBuilder zipkin(URI endpoint)

Set the Zipkin endpoint address.

The resulting Tracer will be sending any tracing data to this location. The significant parts of the URI are userInfo, host and port. Other parts of the endpoint URI are ignored.

Parameters:

endpoint - Zipkin endpoint address. Must not be null.

Returns:

updated builder.

zipkin

public ZipkinTracerBuilder zipkin(String endpoint)

Set the Zipkin endpoint address.

The resulting Tracer will be sending any tracing data to this location. The significant parts of the endpoint URI are userInfo, host and port. Other parts of the endpoint URI are ignored.

Parameters:

endpoint - Zipkin endpoint address. May be null, in which case the default Zipkin endpoint address will be used (http://127.0.0.1:9411/).

Returns:

updated builder.

zipkinHost

public ZipkinTracerBuilder zipkinHost(String hostName)

Set the Zipkin host name.

The resulting Tracer will be sending any tracing data to the Zipkin location address constructed using the supplied host name and the default Zipkin port (i.e. http://<hostName>:9411/).

Parameters:

hostName - Zipkin host name.

Returns:

updated builder.

sender

public ZipkinTracerBuilder sender(zipkin2.reporter.Sender sender)

The sender to use for sending events to Zipkin.

Parameters:

sender - the sender to use

Returns:

this builder

build

public io.opentracing.Tracer build()

Builds the Tracer for Zipkin based on the configured parameters.

Specified by:

build in interface Builder<io.opentracing.Tracer>

Returns:

the tracer