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

Interface HttpConnectionManager.TracingOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      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.
      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.
      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.
      com.google.protobuf.UInt32Value getMaxPathTagLength()
      Maximum length of the request path to extract and include in the HttpUrl tag.
      com.google.protobuf.UInt32ValueOrBuilder getMaxPathTagLengthOrBuilder()
      Maximum length of the request path to extract and include in the HttpUrl tag.
      HttpConnectionManager.Tracing.OperationName getOperationName()
      Deprecated.
      int getOperationNameValue()
      Deprecated.
      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).
      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).
      Tracing.Http getProvider()
      Configuration for an external tracing provider.
      Tracing.HttpOrBuilder getProviderOrBuilder()
      Configuration for an external tracing provider.
      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.
      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.
      String getRequestHeadersForTags​(int index)
      Deprecated.
      com.google.protobuf.ByteString getRequestHeadersForTagsBytes​(int index)
      Deprecated.
      int getRequestHeadersForTagsCount()
      Deprecated.
      List<String> getRequestHeadersForTagsList()
      Deprecated.
      boolean getVerbose()
      Whether to annotate spans with additional data.
      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.
      boolean hasMaxPathTagLength()
      Maximum length of the request path to extract and include in the HttpUrl tag.
      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 hasProvider()
      Configuration for an external tracing provider.
      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.

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

        isInitialized

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

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

    • Method Detail

      • getOperationNameValue

        @Deprecated
int getOperationNameValue()
        Deprecated.
         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) = { ... }

      • getOperationName

        @Deprecated
HttpConnectionManager.Tracing.OperationName getOperationName()
        Deprecated.
         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) = { ... }

      • getRequestHeadersForTagsList

        @Deprecated
List<String> getRequestHeadersForTagsList()
        Deprecated.
         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];

      • getRequestHeadersForTagsCount

        @Deprecated
int getRequestHeadersForTagsCount()
        Deprecated.
         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];

      • getRequestHeadersForTags

        @Deprecated
String getRequestHeadersForTags​(int index)
        Deprecated.
         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];

      • getRequestHeadersForTagsBytes

        @Deprecated
com.google.protobuf.ByteString getRequestHeadersForTagsBytes​(int index)
        Deprecated.
         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];

      • hasClientSampling

        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.Percent client_sampling = 3;

      • getClientSampling

        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_sampling' in the :ref:`HTTP Connection Manager
 <config_http_conn_man_runtime>`.
 Default: 100%
        .envoy.type.Percent client_sampling = 3;

      • getClientSamplingOrBuilder

        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_sampling' in the :ref:`HTTP Connection Manager
 <config_http_conn_man_runtime>`.
 Default: 100%
        .envoy.type.Percent client_sampling = 3;

      • hasRandomSampling

        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;

      • getRandomSampling

        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;

      • getRandomSamplingOrBuilder

        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;

      • hasOverallSampling

        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;

      • getOverallSampling

        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;

      • getOverallSamplingOrBuilder

        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;

      • getVerbose

        boolean getVerbose()
         Whether to annotate spans with additional data. If true, spans will include logs for stream
 events.
        bool verbose = 6;

      • hasMaxPathTagLength

        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;

      • getMaxPathTagLength

        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;

      • getMaxPathTagLengthOrBuilder

        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;

      • getCustomTagsList

        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;

      • getCustomTags

        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;

      • getCustomTagsCount

        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;

      • getCustomTagsOrBuilderList

        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;

      • getCustomTagsOrBuilder

        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;

      • hasProvider

        boolean hasProvider()
         Configuration for an external tracing provider.
 If not specified, no tracing will be performed.
 .. attention::
   Please be aware that *envoy.tracers.opencensus* provider can only be configured once
   in Envoy lifetime.
   Any attempts to reconfigure it or to use different configurations for different HCM filters
   will be rejected.
   Such a constraint is inherent to OpenCensus itself. It cannot be overcome without changes
   on OpenCensus side.
        .envoy.config.trace.v2.Tracing.Http provider = 9;

      • getProvider

        Tracing.Http getProvider()
         Configuration for an external tracing provider.
 If not specified, no tracing will be performed.
 .. attention::
   Please be aware that *envoy.tracers.opencensus* provider can only be configured once
   in Envoy lifetime.
   Any attempts to reconfigure it or to use different configurations for different HCM filters
   will be rejected.
   Such a constraint is inherent to OpenCensus itself. It cannot be overcome without changes
   on OpenCensus side.
        .envoy.config.trace.v2.Tracing.Http provider = 9;

      • getProviderOrBuilder

        Tracing.HttpOrBuilder getProviderOrBuilder()
         Configuration for an external tracing provider.
 If not specified, no tracing will be performed.
 .. attention::
   Please be aware that *envoy.tracers.opencensus* provider can only be configured once
   in Envoy lifetime.
   Any attempts to reconfigure it or to use different configurations for different HCM filters
   will be rejected.
   Such a constraint is inherent to OpenCensus itself. It cannot be overcome without changes
   on OpenCensus side.
        .envoy.config.trace.v2.Tracing.Http provider = 9;