Package io.helidon.webserver.zipkin

Class ZipkinTracerBuilder

java.lang.Object

io.helidon.webserver.zipkin.ZipkinTracerBuilder

All Implemented Interfaces:

Builder<io.opentracing.Tracer>

public final class ZipkinTracerBuilder
extends java.lang.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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ZipkinTracerBuilder.Version	Versions available for Zipkin API.

Method Summary

Modifier and Type	Method	Description
io.opentracing.Tracer	build()	Builds the Tracer for Zipkin based on the configured parameters.
static ZipkinTracerBuilder	forService(java.lang.String serviceName)	Get a Zipkin Tracer builder for processing tracing data of a service with a given name.
static ZipkinTracerBuilder	from(Config config)	Create a new builder based on values in configuration.
ZipkinTracerBuilder	fromConfig(Config config)	Update this builder from configuration.
ZipkinTracerBuilder	path(java.lang.String path)	Override path to use.
ZipkinTracerBuilder	port(int port)	Set the port to use.
ZipkinTracerBuilder	protocol(java.lang.String protocol)	Set the protocol to use (http, https).
ZipkinTracerBuilder	sender(zipkin2.reporter.Sender sender)	The sender to use for sending events to Zipkin.
ZipkinTracerBuilder	version(ZipkinTracerBuilder.Version version)	Version of Zipkin API to use.
ZipkinTracerBuilder	zipkin(java.lang.String endpoint)	Set the Zipkin endpoint address.
ZipkinTracerBuilder	zipkin(java.net.URI endpoint)	Set the Zipkin endpoint address.
ZipkinTracerBuilder	zipkinHost(java.lang.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(java.lang.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.

version

public ZipkinTracerBuilder version(ZipkinTracerBuilder.Version version)

Version of Zipkin API to use. Defaults to ZipkinTracerBuilder.Version.V2.

Parameters:

version - version to use

Returns:

updated builder instance

path

public ZipkinTracerBuilder path(java.lang.String path)

Override path to use. Path is usually defined by the protocol ZipkinTracerBuilder.Version. Use this to override if not using default (e.g. when Zipkin is behind a reverse proxy that prefixes the path).

Parameters:

path - path to override the default defined by ZipkinTracerBuilder.Version

Returns:

updated builder instance

from

public static ZipkinTracerBuilder from(Config config)

Create a new builder based on values in configuration. This requires at least a key "service" in the provided config.

Parameters:

config - configuration to load this builder from

Returns:

a new builder instance.

See Also:

fromConfig(Config)

fromConfig

public ZipkinTracerBuilder fromConfig(Config config)

Update this builder from configuration.

Parameters:

config - configuration that contains at least the key service (if using configuration only).

Returns:

updated builder instance

zipkin

public ZipkinTracerBuilder zipkin(java.net.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(java.lang.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(java.lang.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.

protocol

public ZipkinTracerBuilder protocol(java.lang.String protocol)

Set the protocol to use (http, https). Defaults to .

Parameters:

protocol - protocol to use

Returns:

updated builder instance

port

public ZipkinTracerBuilder port(int port)

Set the port to use. Defaults to .

Parameters:

port - port of the zipkin server

Returns:

updated builder instance

sender

public ZipkinTracerBuilder sender(zipkin2.reporter.Sender sender)

The sender to use for sending events to Zipkin. When configured, all protocol(String), zipkinHost(String), port(int), and version(Version) methods are ignored.

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