Package io.envoyproxy.envoy.config.route.v3

Class Tracing

  • All Implemented Interfaces:
    com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, TracingOrBuilder, Serializable
    public final class Tracing
extends com.google.protobuf.GeneratedMessageV3
implements TracingOrBuilder
    Protobuf type envoy.config.route.v3.Tracing
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  Tracing.Builder
      Protobuf type envoy.config.route.v3.Tracing

      • 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​(Object obj)  
      FractionalPercent getClientSampling()
      Target percentage of requests managed by this HTTP connection manager that will be force traced if the :ref:`x-client-trace-id <config_http_conn_man_headers_x-client-trace-id>` header is set.
      FractionalPercentOrBuilder getClientSamplingOrBuilder()
      Target percentage of requests managed by this HTTP connection manager that will be force traced if the :ref:`x-client-trace-id <config_http_conn_man_headers_x-client-trace-id>` header is set.
      CustomTag getCustomTags​(int index)
      A list of custom tags with unique tag name to create tags for the active span.
      int getCustomTagsCount()
      A list of custom tags with unique tag name to create tags for the active span.
      List<CustomTag> getCustomTagsList()
      A list of custom tags with unique tag name to create tags for the active span.
      CustomTagOrBuilder getCustomTagsOrBuilder​(int index)
      A list of custom tags with unique tag name to create tags for the active span.
      List<? extends CustomTagOrBuilder> getCustomTagsOrBuilderList()
      A list of custom tags with unique tag name to create tags for the active span.
      static Tracing getDefaultInstance()  
      Tracing getDefaultInstanceForType()  
      static com.google.protobuf.Descriptors.Descriptor getDescriptor()  
      FractionalPercent getOverallSampling()
      Target percentage of requests managed by this HTTP connection manager that will be traced after all other sampling checks have been applied (client-directed, force tracing, random sampling).
      FractionalPercentOrBuilder getOverallSamplingOrBuilder()
      Target percentage of requests managed by this HTTP connection manager that will be traced after all other sampling checks have been applied (client-directed, force tracing, random sampling).
      com.google.protobuf.Parser<Tracing> getParserForType()  
      FractionalPercent getRandomSampling()
      Target percentage of requests managed by this HTTP connection manager that will be randomly selected for trace generation, if not requested by the client or not forced.
      FractionalPercentOrBuilder getRandomSamplingOrBuilder()
      Target percentage of requests managed by this HTTP connection manager that will be randomly selected for trace generation, if not requested by the client or not forced.
      int getSerializedSize()  
      com.google.protobuf.UnknownFieldSet getUnknownFields()  
      boolean hasClientSampling()
      Target percentage of requests managed by this HTTP connection manager that will be force traced if the :ref:`x-client-trace-id <config_http_conn_man_headers_x-client-trace-id>` header is set.
      int hashCode()  
      boolean hasOverallSampling()
      Target percentage of requests managed by this HTTP connection manager that will be traced after all other sampling checks have been applied (client-directed, force tracing, random sampling).
      boolean hasRandomSampling()
      Target percentage of requests managed by this HTTP connection manager that will be randomly selected for trace generation, if not requested by the client or not forced.
      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()  
      boolean isInitialized()  
      static Tracing.Builder newBuilder()  
      static Tracing.Builder newBuilder​(Tracing prototype)  
      Tracing.Builder newBuilderForType()  
      protected Tracing.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)  
      protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)  
      static Tracing parseDelimitedFrom​(InputStream input)  
      static Tracing parseDelimitedFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Tracing parseFrom​(byte[] data)  
      static Tracing parseFrom​(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Tracing parseFrom​(com.google.protobuf.ByteString data)  
      static Tracing parseFrom​(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Tracing parseFrom​(com.google.protobuf.CodedInputStream input)  
      static Tracing parseFrom​(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Tracing parseFrom​(InputStream input)  
      static Tracing parseFrom​(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static Tracing parseFrom​(ByteBuffer data)  
      static Tracing parseFrom​(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)  
      static com.google.protobuf.Parser<Tracing> parser()  
      Tracing.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 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

      • CLIENT_SAMPLING_FIELD_NUMBER

        public static final int CLIENT_SAMPLING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • RANDOM_SAMPLING_FIELD_NUMBER

        public static final int RANDOM_SAMPLING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • OVERALL_SAMPLING_FIELD_NUMBER

        public static final int OVERALL_SAMPLING_FIELD_NUMBER
        See Also:
        Constant Field Values

      • CUSTOM_TAGS_FIELD_NUMBER

        public static final int CUSTOM_TAGS_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

      • hasClientSampling

        public boolean hasClientSampling()
         Target percentage of requests managed by this HTTP connection manager that will be force
 traced if the :ref:`x-client-trace-id <config_http_conn_man_headers_x-client-trace-id>`
 header is set. This field is a direct analog for the runtime variable
 'tracing.client_sampling' in the :ref:`HTTP Connection Manager
 <config_http_conn_man_runtime>`.
 Default: 100%
        .envoy.type.v3.FractionalPercent client_sampling = 1;
        Specified by:
        hasClientSampling in interface TracingOrBuilder
        Returns:
        Whether the clientSampling field is set.

      • getClientSampling

        public FractionalPercent getClientSampling()
         Target percentage of requests managed by this HTTP connection manager that will be force
 traced if the :ref:`x-client-trace-id <config_http_conn_man_headers_x-client-trace-id>`
 header is set. This field is a direct analog for the runtime variable
 'tracing.client_sampling' in the :ref:`HTTP Connection Manager
 <config_http_conn_man_runtime>`.
 Default: 100%
        .envoy.type.v3.FractionalPercent client_sampling = 1;
        Specified by:
        getClientSampling in interface TracingOrBuilder
        Returns:
        The clientSampling.

      • getClientSamplingOrBuilder

        public FractionalPercentOrBuilder getClientSamplingOrBuilder()
         Target percentage of requests managed by this HTTP connection manager that will be force
 traced if the :ref:`x-client-trace-id <config_http_conn_man_headers_x-client-trace-id>`
 header is set. This field is a direct analog for the runtime variable
 'tracing.client_sampling' in the :ref:`HTTP Connection Manager
 <config_http_conn_man_runtime>`.
 Default: 100%
        .envoy.type.v3.FractionalPercent client_sampling = 1;
        Specified by:
        getClientSamplingOrBuilder in interface TracingOrBuilder

      • hasRandomSampling

        public boolean hasRandomSampling()
         Target percentage of requests managed by this HTTP connection manager that will be randomly
 selected for trace generation, if not requested by the client or not forced. This field is
 a direct analog for the runtime variable 'tracing.random_sampling' in the
 :ref:`HTTP Connection Manager <config_http_conn_man_runtime>`.
 Default: 100%
        .envoy.type.v3.FractionalPercent random_sampling = 2;
        Specified by:
        hasRandomSampling in interface TracingOrBuilder
        Returns:
        Whether the randomSampling field is set.

      • getRandomSampling

        public FractionalPercent getRandomSampling()
         Target percentage of requests managed by this HTTP connection manager that will be randomly
 selected for trace generation, if not requested by the client or not forced. This field is
 a direct analog for the runtime variable 'tracing.random_sampling' in the
 :ref:`HTTP Connection Manager <config_http_conn_man_runtime>`.
 Default: 100%
        .envoy.type.v3.FractionalPercent random_sampling = 2;
        Specified by:
        getRandomSampling in interface TracingOrBuilder
        Returns:
        The randomSampling.

      • getRandomSamplingOrBuilder

        public FractionalPercentOrBuilder getRandomSamplingOrBuilder()
         Target percentage of requests managed by this HTTP connection manager that will be randomly
 selected for trace generation, if not requested by the client or not forced. This field is
 a direct analog for the runtime variable 'tracing.random_sampling' in the
 :ref:`HTTP Connection Manager <config_http_conn_man_runtime>`.
 Default: 100%
        .envoy.type.v3.FractionalPercent random_sampling = 2;
        Specified by:
        getRandomSamplingOrBuilder in interface TracingOrBuilder

      • hasOverallSampling

        public boolean hasOverallSampling()
         Target percentage of requests managed by this HTTP connection manager that will be traced
 after all other sampling checks have been applied (client-directed, force tracing, random
 sampling). This field functions as an upper limit on the total configured sampling rate. For
 instance, setting client_sampling to 100% but overall_sampling to 1% will result in only 1%
 of client requests with the appropriate headers to be force traced. This field is a direct
 analog for the runtime variable 'tracing.global_enabled' in the
 :ref:`HTTP Connection Manager <config_http_conn_man_runtime>`.
 Default: 100%
        .envoy.type.v3.FractionalPercent overall_sampling = 3;
        Specified by:
        hasOverallSampling in interface TracingOrBuilder
        Returns:
        Whether the overallSampling field is set.

      • getOverallSampling

        public FractionalPercent getOverallSampling()
         Target percentage of requests managed by this HTTP connection manager that will be traced
 after all other sampling checks have been applied (client-directed, force tracing, random
 sampling). This field functions as an upper limit on the total configured sampling rate. For
 instance, setting client_sampling to 100% but overall_sampling to 1% will result in only 1%
 of client requests with the appropriate headers to be force traced. This field is a direct
 analog for the runtime variable 'tracing.global_enabled' in the
 :ref:`HTTP Connection Manager <config_http_conn_man_runtime>`.
 Default: 100%
        .envoy.type.v3.FractionalPercent overall_sampling = 3;
        Specified by:
        getOverallSampling in interface TracingOrBuilder
        Returns:
        The overallSampling.

      • getOverallSamplingOrBuilder

        public FractionalPercentOrBuilder getOverallSamplingOrBuilder()
         Target percentage of requests managed by this HTTP connection manager that will be traced
 after all other sampling checks have been applied (client-directed, force tracing, random
 sampling). This field functions as an upper limit on the total configured sampling rate. For
 instance, setting client_sampling to 100% but overall_sampling to 1% will result in only 1%
 of client requests with the appropriate headers to be force traced. This field is a direct
 analog for the runtime variable 'tracing.global_enabled' in the
 :ref:`HTTP Connection Manager <config_http_conn_man_runtime>`.
 Default: 100%
        .envoy.type.v3.FractionalPercent overall_sampling = 3;
        Specified by:
        getOverallSamplingOrBuilder in interface TracingOrBuilder

      • getCustomTagsList

        public List<CustomTag> getCustomTagsList()
         A list of custom tags with unique tag name to create tags for the active span.
 It will take effect after merging with the :ref:`corresponding configuration
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.custom_tags>`
 configured in the HTTP connection manager. If two tags with the same name are configured
 each in the HTTP connection manager and the route level, the one configured here takes
 priority.
        repeated .envoy.type.tracing.v3.CustomTag custom_tags = 4;
        Specified by:
        getCustomTagsList in interface TracingOrBuilder

      • getCustomTagsOrBuilderList

        public List<? extends CustomTagOrBuilder> getCustomTagsOrBuilderList()
         A list of custom tags with unique tag name to create tags for the active span.
 It will take effect after merging with the :ref:`corresponding configuration
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.custom_tags>`
 configured in the HTTP connection manager. If two tags with the same name are configured
 each in the HTTP connection manager and the route level, the one configured here takes
 priority.
        repeated .envoy.type.tracing.v3.CustomTag custom_tags = 4;
        Specified by:
        getCustomTagsOrBuilderList in interface TracingOrBuilder

      • getCustomTagsCount

        public int getCustomTagsCount()
         A list of custom tags with unique tag name to create tags for the active span.
 It will take effect after merging with the :ref:`corresponding configuration
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.custom_tags>`
 configured in the HTTP connection manager. If two tags with the same name are configured
 each in the HTTP connection manager and the route level, the one configured here takes
 priority.
        repeated .envoy.type.tracing.v3.CustomTag custom_tags = 4;
        Specified by:
        getCustomTagsCount in interface TracingOrBuilder

      • getCustomTags

        public CustomTag getCustomTags​(int index)
         A list of custom tags with unique tag name to create tags for the active span.
 It will take effect after merging with the :ref:`corresponding configuration
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.custom_tags>`
 configured in the HTTP connection manager. If two tags with the same name are configured
 each in the HTTP connection manager and the route level, the one configured here takes
 priority.
        repeated .envoy.type.tracing.v3.CustomTag custom_tags = 4;
        Specified by:
        getCustomTags in interface TracingOrBuilder

      • getCustomTagsOrBuilder

        public CustomTagOrBuilder getCustomTagsOrBuilder​(int index)
         A list of custom tags with unique tag name to create tags for the active span.
 It will take effect after merging with the :ref:`corresponding configuration
 <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.custom_tags>`
 configured in the HTTP connection manager. If two tags with the same name are configured
 each in the HTTP connection manager and the route level, the one configured here takes
 priority.
        repeated .envoy.type.tracing.v3.CustomTag custom_tags = 4;
        Specified by:
        getCustomTagsOrBuilder in interface TracingOrBuilder

      • 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 Tracing parseFrom​(ByteBuffer data)
                         throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • parseFrom

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

      • newBuilderForType

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

      • toBuilder

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

      • newBuilderForType

        protected Tracing.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Tracing getDefaultInstance()

      • parser

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

      • getParserForType

        public com.google.protobuf.Parser<Tracing> 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 Tracing getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder