Module io.helidon.tracing.zipkin

Package io.helidon.tracing.zipkin

Class ZipkinTracerBuilder

java.lang.Object

io.helidon.tracing.zipkin.ZipkinTracerBuilder

All Implemented Interfaces:

Builder<ZipkinTracerBuilder,Tracer>, OpenTracingTracerBuilder<ZipkinTracerBuilder>, Supplier<Tracer>

public class ZipkinTracerBuilder
extends Object
implements OpenTracingTracerBuilder<ZipkinTracerBuilder>

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

Unless You want to explicitly depend on Zipkin in Your code, please use TracerBuilder.create(String) or TracerBuilder.create(Config) that is abstracted.

The following table lists zipkin specific defaults and configuration options.

Tracer Configuration Options

option	default	description
api-version	2	Version of the Zipkin API to use, currently supports 1 and 2
service		Required service name
protocol	http	see TracerBuilder
host	127.0.0.1	see TracerBuilder
port	9411	see TracerBuilder
path	/api/v2/spans	Default for ZipkinTracerBuilder.Version.V2, which is the default version
tags		see TracerBuilder
boolean-tags		see TracerBuilder
int-tags		see TracerBuilder

See Also:

• Zipkin Attributes
• Zipkin Missing Service Name

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	ZipkinTracerBuilder()	Default constructor, does not modify state.

Method Summary

Modifier and Type	Method	Description
ZipkinTracerBuilder	addTracerTag(String key, boolean value)	Tracer level tags that get added to all reported spans.
ZipkinTracerBuilder	addTracerTag(String key, Number value)	Tracer level tags that get added to all reported spans.
ZipkinTracerBuilder	addTracerTag(String key, String value)	Tracer level tags that get added to all reported spans.
ZipkinTracerBuilder	baggage(List<String> baggageKeys)	Baggage keys to be propagated.
Tracer	build()	Builds the Tracer for Zipkin based on the configured parameters.
ZipkinTracerBuilder	collectorHost(String host)	Host to use to connect to tracing collector.
ZipkinTracerBuilder	collectorPath(String path)	Override path to use.
ZipkinTracerBuilder	collectorPort(int port)	Port to use to connect to tracing collector.
ZipkinTracerBuilder	collectorProtocol(String protocol)	Protocol to use (such as http or https) to connect to tracing collector.
ZipkinTracerBuilder	collectorUri(URI uri)	Set the collector URI used for sending tracing data.
ZipkinTracerBuilder	config(Config config)	Load configuration of tracer from configuration of the application.
static ZipkinTracerBuilder	create(Config config)	Create a new builder based on values in configuration.
boolean	enabled()	Return whether this tracer is an enabled tracer with a real backend.
ZipkinTracerBuilder	enabled(boolean enabled)	When enabled, tracing will be sent.
static ZipkinTracerBuilder	forService(String serviceName)	Get a Zipkin Tracer builder for processing tracing data of a service with a given name.
ZipkinTracerBuilder	registerGlobal(boolean global)	When enabled, the created instance is also registered as a global tracer.
ZipkinTracerBuilder	sender(Sender sender)	The sender to use for sending events to Zipkin.
ZipkinTracerBuilder	serviceName(String name)	Service name of the traced service.
<B> B	unwrap(Class<B> builderClass)	Access the underlying builder by specific type.
ZipkinTracerBuilder	version(ZipkinTracerBuilder.Version version)	Version of Zipkin API to use.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.helidon.common.Builder

get, identity, update

Constructor Details

ZipkinTracerBuilder

protected ZipkinTracerBuilder()

Default constructor, does not modify state.

Method Details

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.

create

public static ZipkinTracerBuilder create(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:

• config(Config)

serviceName

public ZipkinTracerBuilder serviceName(String name)

Description copied from interface: OpenTracingTracerBuilder

Service name of the traced service.

Specified by:

serviceName in interface OpenTracingTracerBuilder<ZipkinTracerBuilder>

Parameters:

name - name of the service using the tracer

Returns:

updated builder instance

collectorUri

public ZipkinTracerBuilder collectorUri(URI uri)

Description copied from interface: OpenTracingTracerBuilder

Set the collector URI used for sending tracing data.

Default implementation configures OpenTracingTracerBuilder.collectorProtocol(String), OpenTracingTracerBuilder.collectorHost(String), OpenTracingTracerBuilder.collectorPath(String) and OpenTracingTracerBuilder.collectorPort(int) if configured in the uri.

Specified by:

collectorUri in interface OpenTracingTracerBuilder<ZipkinTracerBuilder>

Parameters:

uri - the endpoint of the tracing collector

Returns:

updated builder instance

collectorProtocol

public ZipkinTracerBuilder collectorProtocol(String protocol)

Description copied from interface: OpenTracingTracerBuilder

Protocol to use (such as http or https) to connect to tracing collector. Default is defined by each tracing integration.

Specified by:

collectorProtocol in interface OpenTracingTracerBuilder<ZipkinTracerBuilder>

Parameters:

protocol - protocol to use

Returns:

updated builder instance

collectorHost

public ZipkinTracerBuilder collectorHost(String host)

Description copied from interface: OpenTracingTracerBuilder

Host to use to connect to tracing collector. Default is defined by each tracing integration.

Specified by:

collectorHost in interface OpenTracingTracerBuilder<ZipkinTracerBuilder>

Parameters:

host - host to use

Returns:

updated builder instance

collectorPort

public ZipkinTracerBuilder collectorPort(int port)

Description copied from interface: OpenTracingTracerBuilder

Port to use to connect to tracing collector. Default is defined by each tracing integration.

Specified by:

collectorPort in interface OpenTracingTracerBuilder<ZipkinTracerBuilder>

Parameters:

port - port to use

Returns:

updated builder instance

collectorPath

public ZipkinTracerBuilder collectorPath(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).

Specified by:

collectorPath in interface OpenTracingTracerBuilder<ZipkinTracerBuilder>

Parameters:

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

Returns:

updated builder instance

enabled

public ZipkinTracerBuilder enabled(boolean enabled)

Description copied from interface: OpenTracingTracerBuilder

When enabled, tracing will be sent. If enabled is false, tracing should use a no-op tracer.

Specified by:

enabled in interface OpenTracingTracerBuilder<ZipkinTracerBuilder>

Parameters:

enabled - set to false to disable distributed tracing

Returns:

updated builder instance

addTracerTag

public ZipkinTracerBuilder addTracerTag(String key,
 String value)

Description copied from interface: OpenTracingTracerBuilder

Tracer level tags that get added to all reported spans.

Specified by:

addTracerTag in interface OpenTracingTracerBuilder<ZipkinTracerBuilder>

Parameters:

key - name of the tag

value - value of the tag

Returns:

updated builder instance

addTracerTag

public ZipkinTracerBuilder addTracerTag(String key,
 Number value)

Description copied from interface: OpenTracingTracerBuilder

Tracer level tags that get added to all reported spans.

Specified by:

addTracerTag in interface OpenTracingTracerBuilder<ZipkinTracerBuilder>

Parameters:

key - name of the tag

value - numeric value of the tag

Returns:

updated builder instance

addTracerTag

public ZipkinTracerBuilder addTracerTag(String key,
 boolean value)

Description copied from interface: OpenTracingTracerBuilder

Tracer level tags that get added to all reported spans.

Specified by:

addTracerTag in interface OpenTracingTracerBuilder<ZipkinTracerBuilder>

Parameters:

key - name of the tag

value - boolean value of the tag

Returns:

updated builder instance

registerGlobal

public ZipkinTracerBuilder registerGlobal(boolean global)

Description copied from interface: OpenTracingTracerBuilder

When enabled, the created instance is also registered as a global tracer.

Specified by:

registerGlobal in interface OpenTracingTracerBuilder<ZipkinTracerBuilder>

Parameters:

global - whether to register this tracer as a global tracer once built

Returns:

updated builder instance

enabled

public boolean enabled()

Description copied from interface: OpenTracingTracerBuilder

Return whether this tracer is an enabled tracer with a real backend.

Specified by:

enabled in interface OpenTracingTracerBuilder<ZipkinTracerBuilder>

Returns:

true if enabled

unwrap

public <B> B unwrap(Class<B> builderClass)

Description copied from interface: OpenTracingTracerBuilder

Access the underlying builder by specific type. This is a dangerous operation that will succeed only if the builder contains the expected type. This practically removes abstraction capabilities of this builder.

Specified by:

unwrap in interface OpenTracingTracerBuilder<ZipkinTracerBuilder>

Type Parameters:

B - type of the builder

Parameters:

builderClass - type to access

Returns:

instance of the builder

config

public ZipkinTracerBuilder config(Config config)

Description copied from interface: OpenTracingTracerBuilder

Load configuration of tracer from configuration of the application. The configuration keys are specific for each tracer integration and documented in these integration projects.

Specified by:

config in interface OpenTracingTracerBuilder<ZipkinTracerBuilder>

Parameters:

config - configuration node of the tracer configuration

Returns:

updated builder instance

build

public Tracer build()

Builds the Tracer for Zipkin based on the configured parameters.

Specified by:

build in interface Builder<ZipkinTracerBuilder,Tracer>

Specified by:

build in interface OpenTracingTracerBuilder<ZipkinTracerBuilder>

Returns:

the tracer

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

baggage

public ZipkinTracerBuilder baggage(List<String> baggageKeys)

Baggage keys to be propagated.

Parameters:

baggageKeys - that will be propagated.

Returns:

updated builder instance

sender

public ZipkinTracerBuilder sender(Sender sender)

The sender to use for sending events to Zipkin. When configured, all collectorProtocol(String), collectorHost(String), collectorPort(int), and version(Version) methods are ignored.

Parameters:

sender - the sender to use

Returns:

this builder