Package io.envoyproxy.envoy.config.trace.v3

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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      String getCollectorCluster()
      The cluster manager cluster that hosts the Zipkin collectors.
      com.google.protobuf.ByteString getCollectorClusterBytes()
      The cluster manager cluster that hosts the Zipkin collectors.
      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.
      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()
      If this is set to true, then Envoy will be treated as an independent hop in trace chain.
      boolean getTraceId128Bit()
      Determines whether a 128bit trace id will be used when creating a new trace instance.
      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 Detail

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

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

        boolean getSplitSpansForRequest()
         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.
        bool split_spans_for_request = 7;
        Returns:
        The splitSpansForRequest.