Package io.envoyproxy.envoy.config.filter.network.http_connection_manager.v2

Class HttpConnectionManager.Tracing

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, HttpConnectionManager.TracingOrBuilder, Serializable
Enclosing class:
HttpConnectionManager
public static final class HttpConnectionManager.Tracing extends com.google.protobuf.GeneratedMessageV3 implements HttpConnectionManager.TracingOrBuilder
 [#next-free-field: 10]
Protobuf type envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing
See Also:

  • Field Details

    • OPERATION_NAME_FIELD_NUMBER

      public static final int OPERATION_NAME_FIELD_NUMBER
      See Also:

    • REQUEST_HEADERS_FOR_TAGS_FIELD_NUMBER

      public static final int REQUEST_HEADERS_FOR_TAGS_FIELD_NUMBER
      See Also:

    • CLIENT_SAMPLING_FIELD_NUMBER

      public static final int CLIENT_SAMPLING_FIELD_NUMBER
      See Also:

    • RANDOM_SAMPLING_FIELD_NUMBER

      public static final int RANDOM_SAMPLING_FIELD_NUMBER
      See Also:

    • OVERALL_SAMPLING_FIELD_NUMBER

      public static final int OVERALL_SAMPLING_FIELD_NUMBER
      See Also:

    • VERBOSE_FIELD_NUMBER

      public static final int VERBOSE_FIELD_NUMBER
      See Also:

    • MAX_PATH_TAG_LENGTH_FIELD_NUMBER

      public static final int MAX_PATH_TAG_LENGTH_FIELD_NUMBER
      See Also:

    • CUSTOM_TAGS_FIELD_NUMBER

      public static final int CUSTOM_TAGS_FIELD_NUMBER
      See Also:

    • PROVIDER_FIELD_NUMBER

      public static final int PROVIDER_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance 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

    • getOperationNameValue

      @Deprecated public int getOperationNameValue()
      Deprecated.
      envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.operation_name is deprecated. See envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto;l=111
       The span name will be derived from this field. If
 :ref:`traffic_direction <envoy_api_field_Listener.traffic_direction>` is
 specified on the parent listener, then it is used instead of this field.

 .. attention::
  This field has been deprecated in favor of `traffic_direction`.
      .envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.OperationName operation_name = 1 [deprecated = true, (.validate.rules) = { ... }
      Specified by:
      getOperationNameValue in interface HttpConnectionManager.TracingOrBuilder
      Returns:
      The enum numeric value on the wire for operationName.

    • getOperationName

      @Deprecated public HttpConnectionManager.Tracing.OperationName getOperationName()
      Deprecated.
      envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.operation_name is deprecated. See envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto;l=111
       The span name will be derived from this field. If
 :ref:`traffic_direction <envoy_api_field_Listener.traffic_direction>` is
 specified on the parent listener, then it is used instead of this field.

 .. attention::
  This field has been deprecated in favor of `traffic_direction`.
      .envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.OperationName operation_name = 1 [deprecated = true, (.validate.rules) = { ... }
      Specified by:
      getOperationName in interface HttpConnectionManager.TracingOrBuilder
      Returns:
      The operationName.

    • getRequestHeadersForTagsList

      @Deprecated public com.google.protobuf.ProtocolStringList getRequestHeadersForTagsList()
      Deprecated.
      envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.request_headers_for_tags is deprecated. See envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto;l=124
       A list of header names used to create tags for the active span. The header name is used to
 populate the tag name, and the header value is used to populate the tag value. The tag is
 created if the specified header name is present in the request's headers.

 .. attention::
  This field has been deprecated in favor of :ref:`custom_tags
  <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.tracing.custom_tags>`.
      repeated string request_headers_for_tags = 2 [deprecated = true];
      Specified by:
      getRequestHeadersForTagsList in interface HttpConnectionManager.TracingOrBuilder
      Returns:
      A list containing the requestHeadersForTags.

    • getRequestHeadersForTagsCount

      @Deprecated public int getRequestHeadersForTagsCount()
      Deprecated.
      envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.request_headers_for_tags is deprecated. See envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto;l=124
       A list of header names used to create tags for the active span. The header name is used to
 populate the tag name, and the header value is used to populate the tag value. The tag is
 created if the specified header name is present in the request's headers.

 .. attention::
  This field has been deprecated in favor of :ref:`custom_tags
  <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.tracing.custom_tags>`.
      repeated string request_headers_for_tags = 2 [deprecated = true];
      Specified by:
      getRequestHeadersForTagsCount in interface HttpConnectionManager.TracingOrBuilder
      Returns:
      The count of requestHeadersForTags.

    • getRequestHeadersForTags

      @Deprecated public String getRequestHeadersForTags(int index)
      Deprecated.
      envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.request_headers_for_tags is deprecated. See envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto;l=124
       A list of header names used to create tags for the active span. The header name is used to
 populate the tag name, and the header value is used to populate the tag value. The tag is
 created if the specified header name is present in the request's headers.

 .. attention::
  This field has been deprecated in favor of :ref:`custom_tags
  <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.tracing.custom_tags>`.
      repeated string request_headers_for_tags = 2 [deprecated = true];
      Specified by:
      getRequestHeadersForTags in interface HttpConnectionManager.TracingOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The requestHeadersForTags at the given index.

    • getRequestHeadersForTagsBytes

      @Deprecated public com.google.protobuf.ByteString getRequestHeadersForTagsBytes(int index)
      Deprecated.
      envoy.config.filter.network.http_connection_manager.v2.HttpConnectionManager.Tracing.request_headers_for_tags is deprecated. See envoy/config/filter/network/http_connection_manager/v2/http_connection_manager.proto;l=124
       A list of header names used to create tags for the active span. The header name is used to
 populate the tag name, and the header value is used to populate the tag value. The tag is
 created if the specified header name is present in the request's headers.

 .. attention::
  This field has been deprecated in favor of :ref:`custom_tags
  <envoy_api_field_config.filter.network.http_connection_manager.v2.HttpConnectionManager.tracing.custom_tags>`.
      repeated string request_headers_for_tags = 2 [deprecated = true];
      Specified by:
      getRequestHeadersForTagsBytes in interface HttpConnectionManager.TracingOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the requestHeadersForTags at the given index.

    • 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_enabled' in the :ref:`HTTP Connection Manager
 <config_http_conn_man_runtime>`.
 Default: 100%
      .envoy.type.Percent client_sampling = 3;
      Specified by:
      hasClientSampling in interface HttpConnectionManager.TracingOrBuilder
      Returns:
      Whether the clientSampling field is set.

    • getClientSampling

      public Percent 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_enabled' in the :ref:`HTTP Connection Manager
 <config_http_conn_man_runtime>`.
 Default: 100%
      .envoy.type.Percent client_sampling = 3;
      Specified by:
      getClientSampling in interface HttpConnectionManager.TracingOrBuilder
      Returns:
      The clientSampling.

    • getClientSamplingOrBuilder

      public PercentOrBuilder 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_enabled' in the :ref:`HTTP Connection Manager
 <config_http_conn_man_runtime>`.
 Default: 100%
      .envoy.type.Percent client_sampling = 3;
      Specified by:
      getClientSamplingOrBuilder in interface HttpConnectionManager.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.Percent random_sampling = 4;
      Specified by:
      hasRandomSampling in interface HttpConnectionManager.TracingOrBuilder
      Returns:
      Whether the randomSampling field is set.

    • getRandomSampling

      public Percent 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.Percent random_sampling = 4;
      Specified by:
      getRandomSampling in interface HttpConnectionManager.TracingOrBuilder
      Returns:
      The randomSampling.

    • getRandomSamplingOrBuilder

      public PercentOrBuilder 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.Percent random_sampling = 4;
      Specified by:
      getRandomSamplingOrBuilder in interface HttpConnectionManager.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.Percent overall_sampling = 5;
      Specified by:
      hasOverallSampling in interface HttpConnectionManager.TracingOrBuilder
      Returns:
      Whether the overallSampling field is set.

    • getOverallSampling

      public Percent 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.Percent overall_sampling = 5;
      Specified by:
      getOverallSampling in interface HttpConnectionManager.TracingOrBuilder
      Returns:
      The overallSampling.

    • getOverallSamplingOrBuilder

      public PercentOrBuilder 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.Percent overall_sampling = 5;
      Specified by:
      getOverallSamplingOrBuilder in interface HttpConnectionManager.TracingOrBuilder

    • getVerbose

      public boolean getVerbose()
       Whether to annotate spans with additional data. If true, spans will include logs for stream
 events.
      bool verbose = 6;
      Specified by:
      getVerbose in interface HttpConnectionManager.TracingOrBuilder
      Returns:
      The verbose.

    • hasMaxPathTagLength

      public boolean hasMaxPathTagLength()
       Maximum length of the request path to extract and include in the HttpUrl tag. Used to
 truncate lengthy request paths to meet the needs of a tracing backend.
 Default: 256
      .google.protobuf.UInt32Value max_path_tag_length = 7;
      Specified by:
      hasMaxPathTagLength in interface HttpConnectionManager.TracingOrBuilder
      Returns:
      Whether the maxPathTagLength field is set.

    • getMaxPathTagLength

      public com.google.protobuf.UInt32Value getMaxPathTagLength()
       Maximum length of the request path to extract and include in the HttpUrl tag. Used to
 truncate lengthy request paths to meet the needs of a tracing backend.
 Default: 256
      .google.protobuf.UInt32Value max_path_tag_length = 7;
      Specified by:
      getMaxPathTagLength in interface HttpConnectionManager.TracingOrBuilder
      Returns:
      The maxPathTagLength.

    • getMaxPathTagLengthOrBuilder

      public com.google.protobuf.UInt32ValueOrBuilder getMaxPathTagLengthOrBuilder()
       Maximum length of the request path to extract and include in the HttpUrl tag. Used to
 truncate lengthy request paths to meet the needs of a tracing backend.
 Default: 256
      .google.protobuf.UInt32Value max_path_tag_length = 7;
      Specified by:
      getMaxPathTagLengthOrBuilder in interface HttpConnectionManager.TracingOrBuilder

    • getCustomTagsList

      public List<CustomTag> getCustomTagsList()
       A list of custom tags with unique tag name to create tags for the active span.
      repeated .envoy.type.tracing.v2.CustomTag custom_tags = 8;
      Specified by:
      getCustomTagsList in interface HttpConnectionManager.TracingOrBuilder

    • getCustomTagsOrBuilderList

      public List<? extends CustomTagOrBuilder> getCustomTagsOrBuilderList()
       A list of custom tags with unique tag name to create tags for the active span.
      repeated .envoy.type.tracing.v2.CustomTag custom_tags = 8;
      Specified by:
      getCustomTagsOrBuilderList in interface HttpConnectionManager.TracingOrBuilder

    • getCustomTagsCount

      public int getCustomTagsCount()
       A list of custom tags with unique tag name to create tags for the active span.
      repeated .envoy.type.tracing.v2.CustomTag custom_tags = 8;
      Specified by:
      getCustomTagsCount in interface HttpConnectionManager.TracingOrBuilder

    • getCustomTags

      public CustomTag getCustomTags(int index)
       A list of custom tags with unique tag name to create tags for the active span.
      repeated .envoy.type.tracing.v2.CustomTag custom_tags = 8;
      Specified by:
      getCustomTags in interface HttpConnectionManager.TracingOrBuilder

    • getCustomTagsOrBuilder

      public CustomTagOrBuilder getCustomTagsOrBuilder(int index)
       A list of custom tags with unique tag name to create tags for the active span.
      repeated .envoy.type.tracing.v2.CustomTag custom_tags = 8;
      Specified by:
      getCustomTagsOrBuilder in interface HttpConnectionManager.TracingOrBuilder

    • hasProvider

      public boolean hasProvider()
       Configuration for an external tracing provider.
 If not specified, no tracing will be performed.
      .envoy.config.trace.v2.Tracing.Http provider = 9;
      Specified by:
      hasProvider in interface HttpConnectionManager.TracingOrBuilder
      Returns:
      Whether the provider field is set.

    • getProvider

      public Tracing.Http getProvider()
       Configuration for an external tracing provider.
 If not specified, no tracing will be performed.
      .envoy.config.trace.v2.Tracing.Http provider = 9;
      Specified by:
      getProvider in interface HttpConnectionManager.TracingOrBuilder
      Returns:
      The provider.

    • getProviderOrBuilder

      public Tracing.HttpOrBuilder getProviderOrBuilder()
       Configuration for an external tracing provider.
 If not specified, no tracing will be performed.
      .envoy.config.trace.v2.Tracing.Http provider = 9;
      Specified by:
      getProviderOrBuilder in interface HttpConnectionManager.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 HttpConnectionManager.Tracing parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static HttpConnectionManager.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 HttpConnectionManager.Tracing parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static HttpConnectionManager.Tracing parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static HttpConnectionManager.Tracing parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static HttpConnectionManager.Tracing.Builder newBuilder()

    • newBuilder

      public static HttpConnectionManager.Tracing.Builder newBuilder(HttpConnectionManager.Tracing prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static HttpConnectionManager.Tracing getDefaultInstance()

    • parser

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

    • getParserForType

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