Interface ZipkinConfigOrBuilder
- 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 TypeMethodDescriptionThe cluster manager cluster that hosts the Zipkin collectors.com.google.protobuf.ByteString
The cluster manager cluster that hosts the Zipkin collectors.The API endpoint of the Zipkin service where the spans will be sent.com.google.protobuf.ByteString
The API endpoint of the Zipkin service where the spans will be sent.Determines the selected collector endpoint version.int
Determines the selected collector endpoint version.Optional hostname to use when sending spans to the collector_cluster.com.google.protobuf.ByteString
Optional hostname to use when sending spans to the collector_cluster.com.google.protobuf.BoolValue
Determines whether client and server spans will share the same span context.com.google.protobuf.BoolValueOrBuilder
Determines whether client and server spans will share the same span context.boolean
Deprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated.boolean
Determines whether a 128bit trace id will be used when creating a new trace instance.boolean
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.
string collector_cluster = 1 [(.validate.rules) = { ... }
- Returns:
- The collectorCluster.
-
getCollectorClusterBytes
com.google.protobuf.ByteString getCollectorClusterBytes()The cluster manager cluster that hosts the Zipkin collectors.
string collector_cluster = 1 [(.validate.rules) = { ... }
- 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.
string collector_endpoint = 2 [(.validate.rules) = { ... }
- 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.
string collector_endpoint = 2 [(.validate.rules) = { ... }
- 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.
-
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.
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.
string collector_hostname = 6;
- Returns:
- The bytes for collectorHostname.
-
getSplitSpansForRequest
Deprecated.envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated. See envoy/config/trace/v3/zipkin.proto;l=88If 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.
-