Class ZipkinConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.envoyproxy.envoy.config.trace.v3.ZipkinConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ZipkinConfigOrBuilder, Serializable
@Generated public final class ZipkinConfig extends com.google.protobuf.GeneratedMessage implements ZipkinConfigOrBuilder
Configuration for the Zipkin tracer.
[#extension: envoy.tracers.zipkin]
[#next-free-field: 8]
Protobuf type envoy.config.trace.v3.ZipkinConfig
See Also:

  • Field Details

    • serialVersionUID

      private static final long serialVersionUID
      See Also:

    • bitField0_

      private int bitField0_

    • COLLECTOR_CLUSTER_FIELD_NUMBER

      public static final int COLLECTOR_CLUSTER_FIELD_NUMBER
      See Also:

    • collectorCluster_

      private volatile Object collectorCluster_

    • COLLECTOR_ENDPOINT_FIELD_NUMBER

      public static final int COLLECTOR_ENDPOINT_FIELD_NUMBER
      See Also:

    • collectorEndpoint_

      private volatile Object collectorEndpoint_

    • TRACE_ID_128BIT_FIELD_NUMBER

      public static final int TRACE_ID_128BIT_FIELD_NUMBER
      See Also:

    • traceId128Bit_

      private boolean traceId128Bit_

    • SHARED_SPAN_CONTEXT_FIELD_NUMBER

      public static final int SHARED_SPAN_CONTEXT_FIELD_NUMBER
      See Also:

    • sharedSpanContext_

      private com.google.protobuf.BoolValue sharedSpanContext_

    • COLLECTOR_ENDPOINT_VERSION_FIELD_NUMBER

      public static final int COLLECTOR_ENDPOINT_VERSION_FIELD_NUMBER
      See Also:

    • collectorEndpointVersion_

      private int collectorEndpointVersion_

    • COLLECTOR_HOSTNAME_FIELD_NUMBER

      public static final int COLLECTOR_HOSTNAME_FIELD_NUMBER
      See Also:

    • collectorHostname_

      private volatile Object collectorHostname_

    • SPLIT_SPANS_FOR_REQUEST_FIELD_NUMBER

      public static final int SPLIT_SPANS_FOR_REQUEST_FIELD_NUMBER
      See Also:

    • splitSpansForRequest_

      private boolean splitSpansForRequest_

    • memoizedIsInitialized

      private byte memoizedIsInitialized

    • DEFAULT_INSTANCE

      private static final ZipkinConfig DEFAULT_INSTANCE

    • PARSER

      private static final com.google.protobuf.Parser<ZipkinConfig> PARSER

  • Constructor Details

    • ZipkinConfig

      private ZipkinConfig(com.google.protobuf.GeneratedMessage.Builder<?> builder)

    • ZipkinConfig

      private ZipkinConfig()

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • getCollectorCluster

      public String getCollectorCluster()
      The cluster manager cluster that hosts the Zipkin collectors.
      string collector_cluster = 1 [(.validate.rules) = { ... }
      Specified by:
      getCollectorCluster in interface ZipkinConfigOrBuilder
      Returns:
      The collectorCluster.

    • getCollectorClusterBytes

      public com.google.protobuf.ByteString getCollectorClusterBytes()
      The cluster manager cluster that hosts the Zipkin collectors.
      string collector_cluster = 1 [(.validate.rules) = { ... }
      Specified by:
      getCollectorClusterBytes in interface ZipkinConfigOrBuilder
      Returns:
      The bytes for collectorCluster.

    • getCollectorEndpoint

      public 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) = { ... }
      Specified by:
      getCollectorEndpoint in interface ZipkinConfigOrBuilder
      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.
      string collector_endpoint = 2 [(.validate.rules) = { ... }
      Specified by:
      getCollectorEndpointBytes in interface ZipkinConfigOrBuilder
      Returns:
      The bytes for collectorEndpoint.

    • 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:
      getTraceId128Bit in interface ZipkinConfigOrBuilder
      Returns:
      The traceId128bit.

    • hasSharedSpanContext

      public 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;
      Specified by:
      hasSharedSpanContext in interface ZipkinConfigOrBuilder
      Returns:
      Whether the sharedSpanContext field is set.

    • getSharedSpanContext

      public 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;
      Specified by:
      getSharedSpanContext in interface ZipkinConfigOrBuilder
      Returns:
      The sharedSpanContext.

    • getSharedSpanContextOrBuilder

      public 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;
      Specified by:
      getSharedSpanContextOrBuilder in interface ZipkinConfigOrBuilder

    • getCollectorEndpointVersionValue

      public int getCollectorEndpointVersionValue()
      Determines the selected collector endpoint version.
      .envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
      Specified by:
      getCollectorEndpointVersionValue in interface ZipkinConfigOrBuilder
      Returns:
      The enum numeric value on the wire for collectorEndpointVersion.

    • getCollectorEndpointVersion

      public ZipkinConfig.CollectorEndpointVersion getCollectorEndpointVersion()
      Determines the selected collector endpoint version.
      .envoy.config.trace.v3.ZipkinConfig.CollectorEndpointVersion collector_endpoint_version = 5;
      Specified by:
      getCollectorEndpointVersion in interface ZipkinConfigOrBuilder
      Returns:
      The collectorEndpointVersion.

    • getCollectorHostname

      public 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;
      Specified by:
      getCollectorHostname in interface ZipkinConfigOrBuilder
      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.
      string collector_hostname = 6;
      Specified by:
      getCollectorHostnameBytes in interface ZipkinConfigOrBuilder
      Returns:
      The bytes for collectorHostname.

    • getSplitSpansForRequest

      @Deprecated public boolean getSplitSpansForRequest()
      Deprecated.
      envoy.config.trace.v3.ZipkinConfig.split_spans_for_request is deprecated. See envoy/config/trace/v3/zipkin.proto;l=88
      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"];
      Specified by:
      getSplitSpansForRequest in interface ZipkinConfigOrBuilder
      Returns:
      The splitSpansForRequest.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ZipkinConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ZipkinConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ZipkinConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ZipkinConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ZipkinConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ZipkinConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ZipkinConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ZipkinConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ZipkinConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ZipkinConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ZipkinConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ZipkinConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ZipkinConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ZipkinConfig.Builder newBuilder()

    • newBuilder

      public static ZipkinConfig.Builder newBuilder(ZipkinConfig prototype)

    • toBuilder

      public ZipkinConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ZipkinConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static ZipkinConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ZipkinConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<ZipkinConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage

    • getDefaultInstanceForType

      public ZipkinConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder