All Superinterfaces:: com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:: ZipkinConfig, ZipkinConfig.Builder

public interface ZipkinConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type

Method

Description

String

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>`.

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>`.

String

getCollectorEndpoint()

The API endpoint of the Zipkin service where the spans will be sent.

com.google.protobuf.ByteString

getCollectorEndpointBytes()

The API endpoint of the Zipkin service where the spans will be sent.

ZipkinConfig.CollectorEndpointVersion

getCollectorEndpointVersion()

Determines the selected collector endpoint version.

int

getCollectorEndpointVersionValue()

Determines the selected collector endpoint version.

String

getCollectorHostname()

Optional hostname to use when sending spans to the collector_cluster.

com.google.protobuf.ByteString

getCollectorHostnameBytes()

Optional hostname to use when sending spans to the collector_cluster.

HttpService

getCollectorService()

HTTP service configuration for the Zipkin collector.

HttpServiceOrBuilder

getCollectorServiceOrBuilder()

HTTP service configuration for the Zipkin collector.

com.google.protobuf.BoolValue

getSharedSpanContext()

Determines whether client and server spans will share the same span context.

com.google.protobuf.BoolValueOrBuilder

getSharedSpanContextOrBuilder()

Determines whether client and server spans will share the same span context.

boolean

getSplitSpansForRequest()

Deprecated.
envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated.

ZipkinConfig.TraceContextOption

getTraceContextOption()

Determines which trace context format to use for trace header extraction and propagation.

int

getTraceContextOptionValue()

Determines which trace context format to use for trace header extraction and propagation.

boolean

getTraceId128Bit()

Determines whether a 128bit trace id will be used when creating a new trace instance.

boolean

hasCollectorService()

HTTP service configuration for the Zipkin collector.

boolean

hasSharedSpanContext()

Determines whether client and server spans will share the same span context.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder
isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

getCollectorCluster

String 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;

Returns:: The collectorCluster.

getCollectorClusterBytes

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;

Returns:: The bytes for collectorCluster.

getCollectorEndpoint

String 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;

Returns:: The collectorEndpoint.

getCollectorEndpointBytes

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;

Returns:: The bytes for collectorEndpoint.

getTraceId128Bit

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;

Returns:: The traceId128bit.

hasSharedSpanContext

boolean hasSharedSpanContext()
```
 Determines whether client and server spans will share the same span context.
 The default value is true.
 
```
.google.protobuf.BoolValue shared_span_context = 4;
Returns:

Whether the sharedSpanContext field is set.
getSharedSpanContext

com.google.protobuf.BoolValue getSharedSpanContext()
```
 Determines whether client and server spans will share the same span context.
 The default value is true.
 
```
.google.protobuf.BoolValue shared_span_context = 4;
Returns:

The sharedSpanContext.
getSharedSpanContextOrBuilder

com.google.protobuf.BoolValueOrBuilder getSharedSpanContextOrBuilder()
```
 Determines whether client and server spans will share the same span context.
 The default value is true.
 
```
.google.protobuf.BoolValue shared_span_context = 4;
getCollectorEndpointVersionValue

int getCollectorEndpointVersionValue()
```
 Determines the selected collector endpoint version.
 
```
.envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
Returns:

The enum numeric value on the wire for collectorEndpointVersion.
getCollectorEndpointVersion

ZipkinConfig.CollectorEndpointVersion getCollectorEndpointVersion()
```
 Determines the selected collector endpoint version.
 
```
.envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
Returns:

The collectorEndpointVersion.

getCollectorHostname

String 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;

Returns:: The collectorHostname.

getCollectorHostnameBytes

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;

Returns:: The bytes for collectorHostname.

getSplitSpansForRequest

@Deprecated boolean getSplitSpansForRequest()

Deprecated.

envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated. See envoy/config/trace/v3/zipkin.proto;l=117

 If 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:: The splitSpansForRequest.

getTraceContextOptionValue

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;

Returns:: The enum numeric value on the wire for traceContextOption.

getTraceContextOption

ZipkinConfig.TraceContextOption 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;

Returns:: The traceContextOption.

hasCollectorService

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;

Returns:: Whether the collectorService field is set.

getCollectorService

HttpService 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;

Returns:: The collectorService.

getCollectorServiceOrBuilder

HttpServiceOrBuilder 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;

Interface ZipkinConfigOrBuilder

Method Summary

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Method Details

getCollectorCluster

getCollectorClusterBytes

getCollectorEndpoint

getCollectorEndpointBytes

getTraceId128Bit

hasSharedSpanContext

getSharedSpanContext

getSharedSpanContextOrBuilder

getCollectorEndpointVersionValue

getCollectorEndpointVersion

getCollectorHostname

getCollectorHostnameBytes

getSplitSpansForRequest

getTraceContextOptionValue

getTraceContextOption

hasCollectorService

getCollectorService

getCollectorServiceOrBuilder