Class ZipkinConfig.Builder
java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>
io.envoyproxy.envoy.config.trace.v3.ZipkinConfig.Builder
- All Implemented Interfaces:
com.google.protobuf.Message.Builder,com.google.protobuf.MessageLite.Builder,com.google.protobuf.MessageLiteOrBuilder,com.google.protobuf.MessageOrBuilder,ZipkinConfigOrBuilder,Cloneable
- Enclosing class:
- ZipkinConfig
public static final class ZipkinConfig.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>
implements ZipkinConfigOrBuilder
Configuration for the Zipkin tracer. [#extension: envoy.tracers.zipkin] [#next-free-field: 10]Protobuf type
envoy.config.trace.v3.ZipkinConfig-
Method Summary
Modifier and TypeMethodDescriptionaddRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) build()clear()The cluster manager cluster that hosts the Zipkin collectors. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`.The API endpoint of the Zipkin service where the spans will be sent.Determines the selected collector endpoint version.Optional hostname to use when sending spans to the collector_cluster.HTTP service configuration for the Zipkin collector.clearField(com.google.protobuf.Descriptors.FieldDescriptor field) clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof) Determines whether client and server spans will share the same span context.Deprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated.Determines which trace context format to use for trace header extraction and propagation.Determines whether a 128bit trace id will be used when creating a new trace instance.clone()The cluster manager cluster that hosts the Zipkin collectors. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`.com.google.protobuf.ByteStringThe cluster manager cluster that hosts the Zipkin collectors. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`.The API endpoint of the Zipkin service where the spans will be sent.com.google.protobuf.ByteStringThe API endpoint of the Zipkin service where the spans will be sent.Determines the selected collector endpoint version.intDetermines the selected collector endpoint version.Optional hostname to use when sending spans to the collector_cluster.com.google.protobuf.ByteStringOptional hostname to use when sending spans to the collector_cluster.HTTP service configuration for the Zipkin collector.HTTP service configuration for the Zipkin collector.HTTP service configuration for the Zipkin collector.static final com.google.protobuf.Descriptors.Descriptorcom.google.protobuf.Descriptors.Descriptorcom.google.protobuf.BoolValueDetermines whether client and server spans will share the same span context.com.google.protobuf.BoolValue.BuilderDetermines whether client and server spans will share the same span context.com.google.protobuf.BoolValueOrBuilderDetermines whether client and server spans will share the same span context.booleanDeprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated.Determines which trace context format to use for trace header extraction and propagation.intDetermines which trace context format to use for trace header extraction and propagation.booleanDetermines whether a 128bit trace id will be used when creating a new trace instance.booleanHTTP service configuration for the Zipkin collector.booleanDetermines whether client and server spans will share the same span context.protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTablefinal booleanmergeCollectorService(HttpService value) HTTP service configuration for the Zipkin collector.mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) mergeFrom(com.google.protobuf.Message other) mergeFrom(ZipkinConfig other) mergeSharedSpanContext(com.google.protobuf.BoolValue value) Determines whether client and server spans will share the same span context.final ZipkinConfig.BuildermergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) setCollectorCluster(String value) The cluster manager cluster that hosts the Zipkin collectors. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`.setCollectorClusterBytes(com.google.protobuf.ByteString value) The cluster manager cluster that hosts the Zipkin collectors. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`.setCollectorEndpoint(String value) The API endpoint of the Zipkin service where the spans will be sent.setCollectorEndpointBytes(com.google.protobuf.ByteString value) The API endpoint of the Zipkin service where the spans will be sent.Determines the selected collector endpoint version.setCollectorEndpointVersionValue(int value) Determines the selected collector endpoint version.setCollectorHostname(String value) Optional hostname to use when sending spans to the collector_cluster.setCollectorHostnameBytes(com.google.protobuf.ByteString value) Optional hostname to use when sending spans to the collector_cluster.setCollectorService(HttpService value) HTTP service configuration for the Zipkin collector.setCollectorService(HttpService.Builder builderForValue) HTTP service configuration for the Zipkin collector.setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) setSharedSpanContext(com.google.protobuf.BoolValue value) Determines whether client and server spans will share the same span context.setSharedSpanContext(com.google.protobuf.BoolValue.Builder builderForValue) Determines whether client and server spans will share the same span context.setSplitSpansForRequest(boolean value) Deprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated.Determines which trace context format to use for trace header extraction and propagation.setTraceContextOptionValue(int value) Determines which trace context format to use for trace header extraction and propagation.setTraceId128Bit(boolean value) Determines whether a 128bit trace id will be used when creating a new trace instance.final ZipkinConfig.BuildersetUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageExceptionMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFromMethods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFromMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Method Details
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>
-
clear
- Specified by:
clearin interfacecom.google.protobuf.Message.Builder- Specified by:
clearin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clearin classcom.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>
-
getDescriptorForType
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.Message.Builder- Specified by:
getDescriptorForTypein interfacecom.google.protobuf.MessageOrBuilder- Overrides:
getDescriptorForTypein classcom.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-
build
- Specified by:
buildin interfacecom.google.protobuf.Message.Builder- Specified by:
buildin interfacecom.google.protobuf.MessageLite.Builder
-
buildPartial
- Specified by:
buildPartialin interfacecom.google.protobuf.Message.Builder- Specified by:
buildPartialin interfacecom.google.protobuf.MessageLite.Builder
-
clone
- Specified by:
clonein interfacecom.google.protobuf.Message.Builder- Specified by:
clonein interfacecom.google.protobuf.MessageLite.Builder- Overrides:
clonein classcom.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>
-
setField
public ZipkinConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
setFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>
-
clearField
- Specified by:
clearFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
clearFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>
-
clearOneof
- Specified by:
clearOneofin interfacecom.google.protobuf.Message.Builder- Overrides:
clearOneofin classcom.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>
-
setRepeatedField
public ZipkinConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value) - Specified by:
setRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
setRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>
-
addRepeatedField
public ZipkinConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value) - Specified by:
addRepeatedFieldin interfacecom.google.protobuf.Message.Builder- Overrides:
addRepeatedFieldin classcom.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>
-
mergeFrom
- Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ZipkinConfig.Builder>
-
mergeFrom
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>
-
mergeFrom
public ZipkinConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Specified by:
mergeFromin interfacecom.google.protobuf.Message.Builder- Specified by:
mergeFromin interfacecom.google.protobuf.MessageLite.Builder- Overrides:
mergeFromin classcom.google.protobuf.AbstractMessage.Builder<ZipkinConfig.Builder>- Throws:
IOException
-
getCollectorCluster
The cluster manager cluster that hosts the Zipkin collectors. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`. Either this field or ``collector_service`` must be specified.string collector_cluster = 1;- Specified by:
getCollectorClusterin interfaceZipkinConfigOrBuilder- Returns:
- The collectorCluster.
-
getCollectorClusterBytes
public com.google.protobuf.ByteString getCollectorClusterBytes()The cluster manager cluster that hosts the Zipkin collectors. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`. Either this field or ``collector_service`` must be specified.string collector_cluster = 1;- Specified by:
getCollectorClusterBytesin interfaceZipkinConfigOrBuilder- Returns:
- The bytes for collectorCluster.
-
setCollectorCluster
The cluster manager cluster that hosts the Zipkin collectors. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`. Either this field or ``collector_service`` must be specified.string collector_cluster = 1;- Parameters:
value- The collectorCluster to set.- Returns:
- This builder for chaining.
-
clearCollectorCluster
The cluster manager cluster that hosts the Zipkin collectors. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`. Either this field or ``collector_service`` must be specified.string collector_cluster = 1;- Returns:
- This builder for chaining.
-
setCollectorClusterBytes
The cluster manager cluster that hosts the Zipkin collectors. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`. Either this field or ``collector_service`` must be specified.string collector_cluster = 1;- Parameters:
value- The bytes for collectorCluster to set.- Returns:
- This builder for chaining.
-
getCollectorEndpoint
The API endpoint of the Zipkin service where the spans will be sent. When using a standard Zipkin installation. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`. Required when using ``collector_cluster``.string collector_endpoint = 2;- Specified by:
getCollectorEndpointin interfaceZipkinConfigOrBuilder- Returns:
- The collectorEndpoint.
-
getCollectorEndpointBytes
public com.google.protobuf.ByteString getCollectorEndpointBytes()The API endpoint of the Zipkin service where the spans will be sent. When using a standard Zipkin installation. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`. Required when using ``collector_cluster``.string collector_endpoint = 2;- Specified by:
getCollectorEndpointBytesin interfaceZipkinConfigOrBuilder- Returns:
- The bytes for collectorEndpoint.
-
setCollectorEndpoint
The API endpoint of the Zipkin service where the spans will be sent. When using a standard Zipkin installation. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`. Required when using ``collector_cluster``.string collector_endpoint = 2;- Parameters:
value- The collectorEndpoint to set.- Returns:
- This builder for chaining.
-
clearCollectorEndpoint
The API endpoint of the Zipkin service where the spans will be sent. When using a standard Zipkin installation. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`. Required when using ``collector_cluster``.string collector_endpoint = 2;- Returns:
- This builder for chaining.
-
setCollectorEndpointBytes
The API endpoint of the Zipkin service where the spans will be sent. When using a standard Zipkin installation. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`. Required when using ``collector_cluster``.string collector_endpoint = 2;- Parameters:
value- The bytes for collectorEndpoint to set.- Returns:
- This builder for chaining.
-
getTraceId128Bit
public boolean getTraceId128Bit()Determines whether a 128bit trace id will be used when creating a new trace instance. The default value is false, which will result in a 64 bit trace id being used.
bool trace_id_128bit = 3;- Specified by:
getTraceId128Bitin interfaceZipkinConfigOrBuilder- Returns:
- The traceId128bit.
-
setTraceId128Bit
Determines whether a 128bit trace id will be used when creating a new trace instance. The default value is false, which will result in a 64 bit trace id being used.
bool trace_id_128bit = 3;- Parameters:
value- The traceId128bit to set.- Returns:
- This builder for chaining.
-
clearTraceId128Bit
Determines whether a 128bit trace id will be used when creating a new trace instance. The default value is false, which will result in a 64 bit trace id being used.
bool trace_id_128bit = 3;- Returns:
- This builder for chaining.
-
getCollectorEndpointVersionValue
public int getCollectorEndpointVersionValue()Determines the selected collector endpoint version.
.envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;- Specified by:
getCollectorEndpointVersionValuein interfaceZipkinConfigOrBuilder- Returns:
- The enum numeric value on the wire for collectorEndpointVersion.
-
setCollectorEndpointVersionValue
Determines the selected collector endpoint version.
.envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;- Parameters:
value- The enum numeric value on the wire for collectorEndpointVersion to set.- Returns:
- This builder for chaining.
-
getCollectorEndpointVersion
Determines the selected collector endpoint version.
.envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;- Specified by:
getCollectorEndpointVersionin interfaceZipkinConfigOrBuilder- Returns:
- The collectorEndpointVersion.
-
setCollectorEndpointVersion
public ZipkinConfig.Builder setCollectorEndpointVersion(ZipkinConfig.CollectorEndpointVersion value) Determines the selected collector endpoint version.
.envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;- Parameters:
value- The collectorEndpointVersion to set.- Returns:
- This builder for chaining.
-
clearCollectorEndpointVersion
Determines the selected collector endpoint version.
.envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;- Returns:
- This builder for chaining.
-
getCollectorHostname
Optional hostname to use when sending spans to the collector_cluster. Useful for collectors that require a specific hostname. Defaults to :ref:`collector_cluster <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_cluster>` above. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`.string collector_hostname = 6;- Specified by:
getCollectorHostnamein interfaceZipkinConfigOrBuilder- Returns:
- The collectorHostname.
-
getCollectorHostnameBytes
public com.google.protobuf.ByteString getCollectorHostnameBytes()Optional hostname to use when sending spans to the collector_cluster. Useful for collectors that require a specific hostname. Defaults to :ref:`collector_cluster <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_cluster>` above. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`.string collector_hostname = 6;- Specified by:
getCollectorHostnameBytesin interfaceZipkinConfigOrBuilder- Returns:
- The bytes for collectorHostname.
-
setCollectorHostname
Optional hostname to use when sending spans to the collector_cluster. Useful for collectors that require a specific hostname. Defaults to :ref:`collector_cluster <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_cluster>` above. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`.string collector_hostname = 6;- Parameters:
value- The collectorHostname to set.- Returns:
- This builder for chaining.
-
clearCollectorHostname
Optional hostname to use when sending spans to the collector_cluster. Useful for collectors that require a specific hostname. Defaults to :ref:`collector_cluster <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_cluster>` above. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`.string collector_hostname = 6;- Returns:
- This builder for chaining.
-
setCollectorHostnameBytes
Optional hostname to use when sending spans to the collector_cluster. Useful for collectors that require a specific hostname. Defaults to :ref:`collector_cluster <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_cluster>` above. .. note:: This field will be deprecated in future releases in favor of :ref:`collector_service <envoy_v3_api_field_config.trace.v3.ZipkinConfig.collector_service>`.string collector_hostname = 6;- Parameters:
value- The bytes for collectorHostname to set.- Returns:
- This builder for chaining.
-
getSplitSpansForRequest
Deprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated. See envoy/config/trace/v3/zipkin.proto;l=117If this is set to true, then Envoy will be treated as an independent hop in trace chain. A complete span pair will be created for a single request. Server span will be created for the downstream request and client span will be created for the related upstream request. This should be set to true in the following cases: * The Envoy Proxy is used as gateway or ingress. * The Envoy Proxy is used as sidecar but inbound traffic capturing or outbound traffic capturing is disabled. * Any case that the :ref:`start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` is set to true. .. attention:: If this is set to true, then the :ref:`start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` SHOULD be set to true also to ensure the correctness of trace chain. Both this field and ``start_child_span`` are deprecated by the :ref:`spawn_upstream_span <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.spawn_upstream_span>`. Please use that ``spawn_upstream_span`` field to control the span creation.
bool split_spans_for_request = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Specified by:
getSplitSpansForRequestin interfaceZipkinConfigOrBuilder- Returns:
- The splitSpansForRequest.
-
setSplitSpansForRequest
Deprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated. See envoy/config/trace/v3/zipkin.proto;l=117If this is set to true, then Envoy will be treated as an independent hop in trace chain. A complete span pair will be created for a single request. Server span will be created for the downstream request and client span will be created for the related upstream request. This should be set to true in the following cases: * The Envoy Proxy is used as gateway or ingress. * The Envoy Proxy is used as sidecar but inbound traffic capturing or outbound traffic capturing is disabled. * Any case that the :ref:`start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` is set to true. .. attention:: If this is set to true, then the :ref:`start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` SHOULD be set to true also to ensure the correctness of trace chain. Both this field and ``start_child_span`` are deprecated by the :ref:`spawn_upstream_span <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.spawn_upstream_span>`. Please use that ``spawn_upstream_span`` field to control the span creation.
bool split_spans_for_request = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Parameters:
value- The splitSpansForRequest to set.- Returns:
- This builder for chaining.
-
clearSplitSpansForRequest
Deprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated. See envoy/config/trace/v3/zipkin.proto;l=117If this is set to true, then Envoy will be treated as an independent hop in trace chain. A complete span pair will be created for a single request. Server span will be created for the downstream request and client span will be created for the related upstream request. This should be set to true in the following cases: * The Envoy Proxy is used as gateway or ingress. * The Envoy Proxy is used as sidecar but inbound traffic capturing or outbound traffic capturing is disabled. * Any case that the :ref:`start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` is set to true. .. attention:: If this is set to true, then the :ref:`start_child_span of router <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` SHOULD be set to true also to ensure the correctness of trace chain. Both this field and ``start_child_span`` are deprecated by the :ref:`spawn_upstream_span <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.spawn_upstream_span>`. Please use that ``spawn_upstream_span`` field to control the span creation.
bool split_spans_for_request = 7 [deprecated = true, (.envoy.annotations.deprecated_at_minor_version) = "3.0"];- Returns:
- This builder for chaining.
-
getTraceContextOptionValue
public int getTraceContextOptionValue()Determines which trace context format to use for trace header extraction and propagation. This controls both downstream request header extraction and upstream request header injection. Here is the spec for W3C trace headers: https://www.w3.org/TR/trace-context/ The default value is USE_B3 to maintain backward compatibility.
.envoy.config.trace.v3.ZipkinConfig.TraceContextOption trace_context_option = 8;- Specified by:
getTraceContextOptionValuein interfaceZipkinConfigOrBuilder- Returns:
- The enum numeric value on the wire for traceContextOption.
-
setTraceContextOptionValue
Determines which trace context format to use for trace header extraction and propagation. This controls both downstream request header extraction and upstream request header injection. Here is the spec for W3C trace headers: https://www.w3.org/TR/trace-context/ The default value is USE_B3 to maintain backward compatibility.
.envoy.config.trace.v3.ZipkinConfig.TraceContextOption trace_context_option = 8;- Parameters:
value- The enum numeric value on the wire for traceContextOption to set.- Returns:
- This builder for chaining.
-
getTraceContextOption
Determines which trace context format to use for trace header extraction and propagation. This controls both downstream request header extraction and upstream request header injection. Here is the spec for W3C trace headers: https://www.w3.org/TR/trace-context/ The default value is USE_B3 to maintain backward compatibility.
.envoy.config.trace.v3.ZipkinConfig.TraceContextOption trace_context_option = 8;- Specified by:
getTraceContextOptionin interfaceZipkinConfigOrBuilder- Returns:
- The traceContextOption.
-
setTraceContextOption
Determines which trace context format to use for trace header extraction and propagation. This controls both downstream request header extraction and upstream request header injection. Here is the spec for W3C trace headers: https://www.w3.org/TR/trace-context/ The default value is USE_B3 to maintain backward compatibility.
.envoy.config.trace.v3.ZipkinConfig.TraceContextOption trace_context_option = 8;- Parameters:
value- The traceContextOption to set.- Returns:
- This builder for chaining.
-
clearTraceContextOption
Determines which trace context format to use for trace header extraction and propagation. This controls both downstream request header extraction and upstream request header injection. Here is the spec for W3C trace headers: https://www.w3.org/TR/trace-context/ The default value is USE_B3 to maintain backward compatibility.
.envoy.config.trace.v3.ZipkinConfig.TraceContextOption trace_context_option = 8;- Returns:
- This builder for chaining.
-
hasCollectorService
public boolean hasCollectorService()HTTP service configuration for the Zipkin collector. When specified, this configuration takes precedence over the legacy fields: collector_cluster, collector_endpoint, and collector_hostname. This provides a complete HTTP service configuration including cluster, URI, timeout, and headers. If not specified, the legacy fields above will be used for backward compatibility. Required fields when using collector_service: * ``http_uri.cluster`` - Must be specified and non-empty * ``http_uri.uri`` - Must be specified and non-empty * ``http_uri.timeout`` - Optional Full URI Support with Automatic Parsing: The ``uri`` field supports both path-only and full URI formats: .. code-block:: yaml tracing: provider: name: envoy.tracers.zipkin typed_config: "@type": type.googleapis.com/envoy.config.trace.v3.ZipkinConfig collector_service: http_uri: # Full URI format - hostname and path are extracted automatically uri: "https://zipkin-collector.example.com/api/v2/spans" cluster: zipkin timeout: 5s request_headers_to_add: - header: key: "X-Custom-Token" value: "your-custom-token" - header: key: "X-Service-ID" value: "your-service-id" URI Parsing Behavior: * Full URI: ``"https://zipkin-collector.example.com/api/v2/spans"`` * Hostname: ``zipkin-collector.example.com`` (sets HTTP ``Host`` header) * Path: ``/api/v2/spans`` (sets HTTP request path) * Path only: ``"/api/v2/spans"`` * Hostname: Uses cluster name as fallback * Path: ``/api/v2/spans``.envoy.config.core.v3.HttpService collector_service = 9;- Specified by:
hasCollectorServicein interfaceZipkinConfigOrBuilder- Returns:
- Whether the collectorService field is set.
-
getCollectorService
HTTP service configuration for the Zipkin collector. When specified, this configuration takes precedence over the legacy fields: collector_cluster, collector_endpoint, and collector_hostname. This provides a complete HTTP service configuration including cluster, URI, timeout, and headers. If not specified, the legacy fields above will be used for backward compatibility. Required fields when using collector_service: * ``http_uri.cluster`` - Must be specified and non-empty * ``http_uri.uri`` - Must be specified and non-empty * ``http_uri.timeout`` - Optional Full URI Support with Automatic Parsing: The ``uri`` field supports both path-only and full URI formats: .. code-block:: yaml tracing: provider: name: envoy.tracers.zipkin typed_config: "@type": type.googleapis.com/envoy.config.trace.v3.ZipkinConfig collector_service: http_uri: # Full URI format - hostname and path are extracted automatically uri: "https://zipkin-collector.example.com/api/v2/spans" cluster: zipkin timeout: 5s request_headers_to_add: - header: key: "X-Custom-Token" value: "your-custom-token" - header: key: "X-Service-ID" value: "your-service-id" URI Parsing Behavior: * Full URI: ``"https://zipkin-collector.example.com/api/v2/spans"`` * Hostname: ``zipkin-collector.example.com`` (sets HTTP ``Host`` header) * Path: ``/api/v2/spans`` (sets HTTP request path) * Path only: ``"/api/v2/spans"`` * Hostname: Uses cluster name as fallback * Path: ``/api/v2/spans``.envoy.config.core.v3.HttpService collector_service = 9;- Specified by:
getCollectorServicein interfaceZipkinConfigOrBuilder- Returns:
- The collectorService.
-
setCollectorService
HTTP service configuration for the Zipkin collector. When specified, this configuration takes precedence over the legacy fields: collector_cluster, collector_endpoint, and collector_hostname. This provides a complete HTTP service configuration including cluster, URI, timeout, and headers. If not specified, the legacy fields above will be used for backward compatibility. Required fields when using collector_service: * ``http_uri.cluster`` - Must be specified and non-empty * ``http_uri.uri`` - Must be specified and non-empty * ``http_uri.timeout`` - Optional Full URI Support with Automatic Parsing: The ``uri`` field supports both path-only and full URI formats: .. code-block:: yaml tracing: provider: name: envoy.tracers.zipkin typed_config: "@type": type.googleapis.com/envoy.config.trace.v3.ZipkinConfig collector_service: http_uri: # Full URI format - hostname and path are extracted automatically uri: "https://zipkin-collector.example.com/api/v2/spans" cluster: zipkin timeout: 5s request_headers_to_add: - header: key: "X-Custom-Token" value: "your-custom-token" - header: key: "X-Service-ID" value: "your-service-id" URI Parsing Behavior: * Full URI: ``"https://zipkin-collector.example.com/api/v2/spans"`` * Hostname: ``zipkin-collector.example.com`` (sets HTTP ``Host`` header) * Path: ``/api/v2/spans`` (sets HTTP request path) * Path only: ``"/api/v2/spans"`` * Hostname: Uses cluster name as fallback * Path: ``/api/v2/spans``.envoy.config.core.v3.HttpService collector_service = 9; -
setCollectorService
HTTP service configuration for the Zipkin collector. When specified, this configuration takes precedence over the legacy fields: collector_cluster, collector_endpoint, and collector_hostname. This provides a complete HTTP service configuration including cluster, URI, timeout, and headers. If not specified, the legacy fields above will be used for backward compatibility. Required fields when using collector_service: * ``http_uri.cluster`` - Must be specified and non-empty * ``http_uri.uri`` - Must be specified and non-empty * ``http_uri.timeout`` - Optional Full URI Support with Automatic Parsing: The ``uri`` field supports both path-only and full URI formats: .. code-block:: yaml tracing: provider: name: envoy.tracers.zipkin typed_config: "@type": type.googleapis.com/envoy.config.trace.v3.ZipkinConfig collector_service: http_uri: # Full URI format - hostname and path are extracted automatically uri: "https://zipkin-collector.example.com/api/v2/spans" cluster: zipkin timeout: 5s request_headers_to_add: - header: key: "X-Custom-Token" value: "your-custom-token" - header: key: "X-Service-ID" value: "your-service-id" URI Parsing Behavior: * Full URI: ``"https://zipkin-collector.example.com/api/v2/spans"`` * Hostname: ``zipkin-collector.example.com`` (sets HTTP ``Host`` header) * Path: ``/api/v2/spans`` (sets HTTP request path) * Path only: ``"/api/v2/spans"`` * Hostname: Uses cluster name as fallback * Path: ``/api/v2/spans``.envoy.config.core.v3.HttpService collector_service = 9; -
mergeCollectorService
HTTP service configuration for the Zipkin collector. When specified, this configuration takes precedence over the legacy fields: collector_cluster, collector_endpoint, and collector_hostname. This provides a complete HTTP service configuration including cluster, URI, timeout, and headers. If not specified, the legacy fields above will be used for backward compatibility. Required fields when using collector_service: * ``http_uri.cluster`` - Must be specified and non-empty * ``http_uri.uri`` - Must be specified and non-empty * ``http_uri.timeout`` - Optional Full URI Support with Automatic Parsing: The ``uri`` field supports both path-only and full URI formats: .. code-block:: yaml tracing: provider: name: envoy.tracers.zipkin typed_config: "@type": type.googleapis.com/envoy.config.trace.v3.ZipkinConfig collector_service: http_uri: # Full URI format - hostname and path are extracted automatically uri: "https://zipkin-collector.example.com/api/v2/spans" cluster: zipkin timeout: 5s request_headers_to_add: - header: key: "X-Custom-Token" value: "your-custom-token" - header: key: "X-Service-ID" value: "your-service-id" URI Parsing Behavior: * Full URI: ``"https://zipkin-collector.example.com/api/v2/spans"`` * Hostname: ``zipkin-collector.example.com`` (sets HTTP ``Host`` header) * Path: ``/api/v2/spans`` (sets HTTP request path) * Path only: ``"/api/v2/spans"`` * Hostname: Uses cluster name as fallback * Path: ``/api/v2/spans``.envoy.config.core.v3.HttpService collector_service = 9; -
clearCollectorService
HTTP service configuration for the Zipkin collector. When specified, this configuration takes precedence over the legacy fields: collector_cluster, collector_endpoint, and collector_hostname. This provides a complete HTTP service configuration including cluster, URI, timeout, and headers. If not specified, the legacy fields above will be used for backward compatibility. Required fields when using collector_service: * ``http_uri.cluster`` - Must be specified and non-empty * ``http_uri.uri`` - Must be specified and non-empty * ``http_uri.timeout`` - Optional Full URI Support with Automatic Parsing: The ``uri`` field supports both path-only and full URI formats: .. code-block:: yaml tracing: provider: name: envoy.tracers.zipkin typed_config: "@type": type.googleapis.com/envoy.config.trace.v3.ZipkinConfig collector_service: http_uri: # Full URI format - hostname and path are extracted automatically uri: "https://zipkin-collector.example.com/api/v2/spans" cluster: zipkin timeout: 5s request_headers_to_add: - header: key: "X-Custom-Token" value: "your-custom-token" - header: key: "X-Service-ID" value: "your-service-id" URI Parsing Behavior: * Full URI: ``"https://zipkin-collector.example.com/api/v2/spans"`` * Hostname: ``zipkin-collector.example.com`` (sets HTTP ``Host`` header) * Path: ``/api/v2/spans`` (sets HTTP request path) * Path only: ``"/api/v2/spans"`` * Hostname: Uses cluster name as fallback * Path: ``/api/v2/spans``.envoy.config.core.v3.HttpService collector_service = 9; -
getCollectorServiceBuilder
HTTP service configuration for the Zipkin collector. When specified, this configuration takes precedence over the legacy fields: collector_cluster, collector_endpoint, and collector_hostname. This provides a complete HTTP service configuration including cluster, URI, timeout, and headers. If not specified, the legacy fields above will be used for backward compatibility. Required fields when using collector_service: * ``http_uri.cluster`` - Must be specified and non-empty * ``http_uri.uri`` - Must be specified and non-empty * ``http_uri.timeout`` - Optional Full URI Support with Automatic Parsing: The ``uri`` field supports both path-only and full URI formats: .. code-block:: yaml tracing: provider: name: envoy.tracers.zipkin typed_config: "@type": type.googleapis.com/envoy.config.trace.v3.ZipkinConfig collector_service: http_uri: # Full URI format - hostname and path are extracted automatically uri: "https://zipkin-collector.example.com/api/v2/spans" cluster: zipkin timeout: 5s request_headers_to_add: - header: key: "X-Custom-Token" value: "your-custom-token" - header: key: "X-Service-ID" value: "your-service-id" URI Parsing Behavior: * Full URI: ``"https://zipkin-collector.example.com/api/v2/spans"`` * Hostname: ``zipkin-collector.example.com`` (sets HTTP ``Host`` header) * Path: ``/api/v2/spans`` (sets HTTP request path) * Path only: ``"/api/v2/spans"`` * Hostname: Uses cluster name as fallback * Path: ``/api/v2/spans``.envoy.config.core.v3.HttpService collector_service = 9; -
getCollectorServiceOrBuilder
HTTP service configuration for the Zipkin collector. When specified, this configuration takes precedence over the legacy fields: collector_cluster, collector_endpoint, and collector_hostname. This provides a complete HTTP service configuration including cluster, URI, timeout, and headers. If not specified, the legacy fields above will be used for backward compatibility. Required fields when using collector_service: * ``http_uri.cluster`` - Must be specified and non-empty * ``http_uri.uri`` - Must be specified and non-empty * ``http_uri.timeout`` - Optional Full URI Support with Automatic Parsing: The ``uri`` field supports both path-only and full URI formats: .. code-block:: yaml tracing: provider: name: envoy.tracers.zipkin typed_config: "@type": type.googleapis.com/envoy.config.trace.v3.ZipkinConfig collector_service: http_uri: # Full URI format - hostname and path are extracted automatically uri: "https://zipkin-collector.example.com/api/v2/spans" cluster: zipkin timeout: 5s request_headers_to_add: - header: key: "X-Custom-Token" value: "your-custom-token" - header: key: "X-Service-ID" value: "your-service-id" URI Parsing Behavior: * Full URI: ``"https://zipkin-collector.example.com/api/v2/spans"`` * Hostname: ``zipkin-collector.example.com`` (sets HTTP ``Host`` header) * Path: ``/api/v2/spans`` (sets HTTP request path) * Path only: ``"/api/v2/spans"`` * Hostname: Uses cluster name as fallback * Path: ``/api/v2/spans``.envoy.config.core.v3.HttpService collector_service = 9;- Specified by:
getCollectorServiceOrBuilderin interfaceZipkinConfigOrBuilder
-
setUnknownFields
public final ZipkinConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
setUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
setUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>
-
mergeUnknownFields
public final ZipkinConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields) - Specified by:
mergeUnknownFieldsin interfacecom.google.protobuf.Message.Builder- Overrides:
mergeUnknownFieldsin classcom.google.protobuf.GeneratedMessageV3.Builder<ZipkinConfig.Builder>
-