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

Class ZipkinConfig

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ZipkinConfigOrBuilder, java.io.Serializable
    public final class ZipkinConfig
extends com.google.protobuf.GeneratedMessageV3
implements ZipkinConfigOrBuilder
     Configuration for the Zipkin tracer.
 [#extension: envoy.tracers.zipkin]
 [#next-free-field: 8]
    Protobuf type envoy.config.trace.v3.ZipkinConfig
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  ZipkinConfig.Builder
      Configuration for the Zipkin tracer.
      static class  ZipkinConfig.CollectorEndpointVersion
      Available Zipkin collector endpoint versions.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,​BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,​BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      boolean equals​(java.lang.Object obj)  
      java.lang.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.
      java.lang.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.
      java.lang.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.
      static ZipkinConfig getDefaultInstance()  
      ZipkinConfig getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      com.google.protobuf.Parser<ZipkinConfig> getParserForType()  
      int getSerializedSize()  
      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.
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      int hashCode()  
      boolean hasSharedSpanContext()
      Determines whether client and server spans will share the same span context.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static ZipkinConfig.Builder newBuilder()  
      static ZipkinConfig.Builder newBuilder​(ZipkinConfig prototype)  
      ZipkinConfig.Builder newBuilderForType()  
      protected ZipkinConfig.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static ZipkinConfig parseDelimitedFrom​(java.io.InputStream input)  
      static ZipkinConfig parseDelimitedFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ZipkinConfig parseFrom​(byte[] data)  
      static ZipkinConfig parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ZipkinConfig parseFrom​(com.google.protobuf.ByteString data)  
      static ZipkinConfig parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ZipkinConfig parseFrom​(com.google.protobuf.CodedInputStream input)  
      static ZipkinConfig parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ZipkinConfig parseFrom​(java.io.InputStream input)  
      static ZipkinConfig parseFrom​(java.io.InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static ZipkinConfig parseFrom​(java.nio.ByteBuffer data)  
      static ZipkinConfig parseFrom​(java.nio.ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<ZipkinConfig> parser()  
      ZipkinConfig.Builder toBuilder()  
      void writeTo​(com.google.protobuf.CodedOutputStream output)  

      • Methods inherited from class com.google.protobuf.GeneratedMessageV3

        canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

      • Methods inherited from class com.google.protobuf.AbstractMessage

        findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

      • Methods inherited from class com.google.protobuf.AbstractMessageLite

        addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from class java.lang.Object

        clone, finalize, getClass, notify, notifyAll, wait, wait, wait

      • Methods inherited from interface com.google.protobuf.MessageLite

        toByteArray, toByteString, writeDelimitedTo, writeTo

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

    • Field Detail

      • COLLECTOR_CLUSTER_FIELD_NUMBER

        public static final int COLLECTOR_CLUSTER_FIELD_NUMBER
        See Also:
        Constant Field Values

      • COLLECTOR_ENDPOINT_FIELD_NUMBER

        public static final int COLLECTOR_ENDPOINT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • TRACE_ID_128BIT_FIELD_NUMBER

        public static final int TRACE_ID_128BIT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SHARED_SPAN_CONTEXT_FIELD_NUMBER

        public static final int SHARED_SPAN_CONTEXT_FIELD_NUMBER
        See Also:
        Constant Field Values

      • COLLECTOR_ENDPOINT_VERSION_FIELD_NUMBER

        public static final int COLLECTOR_ENDPOINT_VERSION_FIELD_NUMBER
        See Also:
        Constant Field Values

      • COLLECTOR_HOSTNAME_FIELD_NUMBER

        public static final int COLLECTOR_HOSTNAME_FIELD_NUMBER
        See Also:
        Constant Field Values

      • SPLIT_SPANS_FOR_REQUEST_FIELD_NUMBER

        public static final int SPLIT_SPANS_FOR_REQUEST_FIELD_NUMBER
        See Also:
        Constant Field Values

    • Method Detail

      • newInstance

        protected java.lang.Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getUnknownFields

        public final com.google.protobuf.UnknownFieldSet getUnknownFields()
        Specified by:
        getUnknownFields in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getUnknownFields in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

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

      • getCollectorCluster

        public java.lang.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 java.lang.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.

      • getCollectorHostname

        public java.lang.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

        public 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 `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;
        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.GeneratedMessageV3

      • writeTo

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

      • getSerializedSize

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

      • equals

        public boolean equals​(java.lang.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​(java.nio.ByteBuffer data)
                              throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static ZipkinConfig parseFrom​(java.nio.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​(java.io.InputStream input)
                              throws java.io.IOException
        Throws:
        java.io.IOException

      • parseFrom

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

      • parseDelimitedFrom

        public static ZipkinConfig parseDelimitedFrom​(java.io.InputStream input)
                                       throws java.io.IOException
        Throws:
        java.io.IOException

      • parseDelimitedFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • 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.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

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

      • getDefaultInstanceForType

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