Package io.envoyproxy.envoy.config.trace.v2

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

    • getCollectorCluster

      String getCollectorCluster()
       The cluster manager cluster that hosts the Zipkin collectors. Note that the
 Zipkin cluster must be defined in the :ref:`Bootstrap static cluster
 resources <envoy_api_field_config.bootstrap.v2.Bootstrap.StaticResources.clusters>`.
      string collector_cluster = 1 [(.validate.rules) = { ... }
      Returns:
      The collectorCluster.

    • getCollectorClusterBytes

      com.google.protobuf.ByteString getCollectorClusterBytes()
       The cluster manager cluster that hosts the Zipkin collectors. Note that the
 Zipkin cluster must be defined in the :ref:`Bootstrap static cluster
 resources <envoy_api_field_config.bootstrap.v2.Bootstrap.StaticResources.clusters>`.
      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, the API endpoint is typically
 /api/v1/spans, which is the default value.
      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, the API endpoint is typically
 /api/v1/spans, which is the default value.
      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. By default, the ``HTTP_JSON_V1`` will be
 used.
      .envoy.config.trace.v2.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. By default, the ``HTTP_JSON_V1`` will be
 used.
      .envoy.config.trace.v2.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
      Returns:
      The collectorEndpointVersion.