Class ZipkinTracerBuilder
java.lang.Object
io.helidon.tracing.providers.zipkin.ZipkinTracerBuilder
- All Implemented Interfaces:
Builder<ZipkinTracerBuilder,,Tracer> OpenTracingTracerBuilder<ZipkinTracerBuilder>,Supplier<Tracer>
@Deprecated(since="4.5.7",
forRemoval=true)
public class ZipkinTracerBuilder
extends Object
implements OpenTracingTracerBuilder<ZipkinTracerBuilder>
Deprecated, for removal: This API element is subject to removal in a future version.
Use the OpenTelemetry tracing provider instead.
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.
| 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:
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enumDeprecated, for removal: This API element is subject to removal in a future version.Versions available for Zipkin API. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedDeprecated, for removal: This API element is subject to removal in a future version.Default constructor, does not modify state. -
Method Summary
Modifier and TypeMethodDescriptionaddTracerTag(String key, boolean value) Deprecated, for removal: This API element is subject to removal in a future version.Tracer level tags that get added to all reported spans.addTracerTag(String key, Number value) Deprecated, for removal: This API element is subject to removal in a future version.Tracer level tags that get added to all reported spans.addTracerTag(String key, String value) Deprecated, for removal: This API element is subject to removal in a future version.Tracer level tags that get added to all reported spans.build()Deprecated, for removal: This API element is subject to removal in a future version.Builds theTracerfor Zipkin based on the configured parameters.collectorHost(String host) Deprecated, for removal: This API element is subject to removal in a future version.Host to use to connect to tracing collector.collectorPath(String path) Deprecated, for removal: This API element is subject to removal in a future version.Override path to use.collectorPort(int port) Deprecated, for removal: This API element is subject to removal in a future version.Port to use to connect to tracing collector.collectorProtocol(String protocol) Deprecated, for removal: This API element is subject to removal in a future version.Protocol to use (such ashttporhttps) to connect to tracing collector.collectorUri(URI uri) Deprecated, for removal: This API element is subject to removal in a future version.Set the collector URI used for sending tracing data.Deprecated, for removal: This API element is subject to removal in a future version.Load configuration of tracer from configuration of the application.static ZipkinTracerBuilderDeprecated, for removal: This API element is subject to removal in a future version.useconfig(io.helidon.config.Config)insteadstatic ZipkinTracerBuilderDeprecated, for removal: This API element is subject to removal in a future version.Create a new builder based on values in configuration.booleanenabled()Deprecated, for removal: This API element is subject to removal in a future version.Return whether this tracer is an enabled tracer with a real backend.enabled(boolean enabled) Deprecated, for removal: This API element is subject to removal in a future version.When enabled, tracing will be sent.static ZipkinTracerBuilderforService(String serviceName) Deprecated, for removal: This API element is subject to removal in a future version.Get a ZipkinTracerbuilder for processing tracing data of a service with a given name.registerGlobal(boolean global) Deprecated, for removal: This API element is subject to removal in a future version.When enabled, the created instance is also registered as a global tracer.Deprecated, for removal: This API element is subject to removal in a future version.The sender to use for sending events to Zipkin.serviceName(String name) Deprecated, for removal: This API element is subject to removal in a future version.Service name of the traced service.<B> BDeprecated, for removal: This API element is subject to removal in a future version.Access the underlying builder by specific type.version(ZipkinTracerBuilder.Version version) Deprecated, for removal: This API element is subject to removal in a future version.Version of Zipkin API to use.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface io.helidon.tracing.providers.opentracing.OpenTracingTracerBuilder
config
-
Constructor Details
-
ZipkinTracerBuilder
protected ZipkinTracerBuilder()Deprecated, for removal: This API element is subject to removal in a future version.Default constructor, does not modify state.
-
-
Method Details
-
forService
Deprecated, for removal: This API element is subject to removal in a future version.Get a ZipkinTracerbuilder for processing tracing data of a service with a given name.- Parameters:
serviceName- name of the service that will be using the tracer.- Returns:
Tracerbuilder for Zipkin.
-
create
Deprecated, for removal: This API element is subject to removal in a future version.useconfig(io.helidon.config.Config)insteadCreate a instance from configuration.- Parameters:
config- configuration- Returns:
- a new builder instance.
-
create
Deprecated, for removal: This API element is subject to removal in a future version.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:
-
serviceName
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:OpenTracingTracerBuilderService name of the traced service.- Specified by:
serviceNamein interfaceOpenTracingTracerBuilder<ZipkinTracerBuilder>- Parameters:
name- name of the service using the tracer- Returns:
- updated builder instance
-
collectorUri
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:OpenTracingTracerBuilderSet the collector URI used for sending tracing data.Default implementation configures
OpenTracingTracerBuilder.collectorProtocol(String),OpenTracingTracerBuilder.collectorHost(String),OpenTracingTracerBuilder.collectorPath(String)andOpenTracingTracerBuilder.collectorPort(int)if configured in the uri.- Specified by:
collectorUriin interfaceOpenTracingTracerBuilder<ZipkinTracerBuilder>- Parameters:
uri- the endpoint of the tracing collector- Returns:
- updated builder instance
-
collectorProtocol
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:OpenTracingTracerBuilderProtocol to use (such ashttporhttps) to connect to tracing collector. Default is defined by each tracing integration.- Specified by:
collectorProtocolin interfaceOpenTracingTracerBuilder<ZipkinTracerBuilder>- Parameters:
protocol- protocol to use- Returns:
- updated builder instance
-
collectorHost
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:OpenTracingTracerBuilderHost to use to connect to tracing collector. Default is defined by each tracing integration.- Specified by:
collectorHostin interfaceOpenTracingTracerBuilder<ZipkinTracerBuilder>- Parameters:
host- host to use- Returns:
- updated builder instance
-
collectorPort
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:OpenTracingTracerBuilderPort to use to connect to tracing collector. Default is defined by each tracing integration.- Specified by:
collectorPortin interfaceOpenTracingTracerBuilder<ZipkinTracerBuilder>- Parameters:
port- port to use- Returns:
- updated builder instance
-
collectorPath
Deprecated, for removal: This API element is subject to removal in a future version.Override path to use. Path is usually defined by the protocolZipkinTracerBuilder.Version. Use this to override if not using default (e.g. when Zipkin is behind a reverse proxy that prefixes the path).- Specified by:
collectorPathin interfaceOpenTracingTracerBuilder<ZipkinTracerBuilder>- Parameters:
path- path to override the default defined byZipkinTracerBuilder.Version- Returns:
- updated builder instance
-
enabled
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:OpenTracingTracerBuilderWhen enabled, tracing will be sent. If enabled is false, tracing should use a no-op tracer.- Specified by:
enabledin interfaceOpenTracingTracerBuilder<ZipkinTracerBuilder>- Parameters:
enabled- set tofalseto disable distributed tracing- Returns:
- updated builder instance
-
addTracerTag
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:OpenTracingTracerBuilderTracer level tags that get added to all reported spans.- Specified by:
addTracerTagin interfaceOpenTracingTracerBuilder<ZipkinTracerBuilder>- Parameters:
key- name of the tagvalue- value of the tag- Returns:
- updated builder instance
-
addTracerTag
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:OpenTracingTracerBuilderTracer level tags that get added to all reported spans.- Specified by:
addTracerTagin interfaceOpenTracingTracerBuilder<ZipkinTracerBuilder>- Parameters:
key- name of the tagvalue- numeric value of the tag- Returns:
- updated builder instance
-
addTracerTag
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:OpenTracingTracerBuilderTracer level tags that get added to all reported spans.- Specified by:
addTracerTagin interfaceOpenTracingTracerBuilder<ZipkinTracerBuilder>- Parameters:
key- name of the tagvalue- boolean value of the tag- Returns:
- updated builder instance
-
registerGlobal
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:OpenTracingTracerBuilderWhen enabled, the created instance is also registered as a global tracer.- Specified by:
registerGlobalin interfaceOpenTracingTracerBuilder<ZipkinTracerBuilder>- Parameters:
global- whether to register this tracer as a global tracer once built- Returns:
- updated builder instance
-
enabled
public boolean enabled()Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:OpenTracingTracerBuilderReturn whether this tracer is an enabled tracer with a real backend.- Specified by:
enabledin interfaceOpenTracingTracerBuilder<ZipkinTracerBuilder>- Returns:
trueif enabled
-
unwrap
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:OpenTracingTracerBuilderAccess 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:
unwrapin interfaceOpenTracingTracerBuilder<ZipkinTracerBuilder>- Type Parameters:
B- type of the builder- Parameters:
builderClass- type to access- Returns:
- instance of the builder
-
config
Deprecated, for removal: This API element is subject to removal in a future version.Description copied from interface:OpenTracingTracerBuilderLoad configuration of tracer from configuration of the application. The configuration keys are specific for each tracer integration and documented in these integration projects.API Note: the default method implementation is provided for backward compatibility and will be removed in the next major version
- Specified by:
configin interfaceOpenTracingTracerBuilder<ZipkinTracerBuilder>- Parameters:
config- configuration node of the tracer configuration- Returns:
- updated builder instance
-
build
Deprecated, for removal: This API element is subject to removal in a future version.Builds theTracerfor Zipkin based on the configured parameters.- Specified by:
buildin interfaceBuilder<ZipkinTracerBuilder,Tracer> - Specified by:
buildin interfaceOpenTracingTracerBuilder<ZipkinTracerBuilder>- Returns:
- the tracer
-
version
Deprecated, for removal: This API element is subject to removal in a future version.Version of Zipkin API to use. Defaults toZipkinTracerBuilder.Version.V2.- Parameters:
version- version to use- Returns:
- updated builder instance
-
sender
Deprecated, for removal: This API element is subject to removal in a future version.The sender to use for sending events to Zipkin. When configured, allcollectorProtocol(String),collectorHost(String),collectorPort(int), andversion(Version)methods are ignored.- Parameters:
sender- the sender to use- Returns:
- this builder
-