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, Serializable
    public final class ZipkinConfig
extends com.google.protobuf.GeneratedMessageV3
implements ZipkinConfigOrBuilder
     Configuration for the Zipkin tracer.
 [#extension: envoy.tracers.zipkin]
 [#next-free-field: 7]
    Protobuf type envoy.config.trace.v3.ZipkinConfig
    See Also:
    Serialized Form

    • 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

    • Method Detail

      • newInstance

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

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

      • 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 IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        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​(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​(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

      • 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