Interface HttpConnectionManager.TracingOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
HttpConnectionManager.Tracing
,HttpConnectionManager.Tracing.Builder
- Enclosing class:
HttpConnectionManager
public static interface HttpConnectionManager.TracingOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionTarget 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.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.getCustomTags
(int index) A list of custom tags with unique tag name to create tags for the active span.int
A list of custom tags with unique tag name to create tags for the active span.A list of custom tags with unique tag name to create tags for the active span.getCustomTagsOrBuilder
(int index) A list of custom tags with unique tag name to create tags for the active span.List
<? extends CustomTagOrBuilder> A list of custom tags with unique tag name to create tags for the active span.com.google.protobuf.UInt32Value
Maximum length of the request path to extract and include in the HttpUrl tag.com.google.protobuf.UInt32ValueOrBuilder
Maximum length of the request path to extract and include in the HttpUrl tag.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).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).Configuration for an external tracing provider.Configuration for an external tracing provider.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.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.com.google.protobuf.BoolValue
Create separate tracing span for each upstream request if true.com.google.protobuf.BoolValueOrBuilder
Create separate tracing span for each upstream request if true.boolean
Whether to annotate spans with additional data.boolean
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
Maximum length of the request path to extract and include in the HttpUrl tag.boolean
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
Configuration for an external tracing provider.boolean
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.boolean
Create separate tracing span for each upstream request if true.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 Details
-
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_enabled' in the :ref:`HTTP Connection Manager <config_http_conn_man_runtime>`. Default: 100%
.envoy.type.v3.Percent client_sampling = 3;
- Returns:
- Whether the clientSampling field is set.
-
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_enabled' in the :ref:`HTTP Connection Manager <config_http_conn_man_runtime>`. Default: 100%
.envoy.type.v3.Percent client_sampling = 3;
- Returns:
- The clientSampling.
-
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_enabled' in the :ref:`HTTP Connection Manager <config_http_conn_man_runtime>`. Default: 100%
.envoy.type.v3.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.v3.Percent random_sampling = 4;
- Returns:
- Whether the randomSampling field is set.
-
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.v3.Percent random_sampling = 4;
- Returns:
- The randomSampling.
-
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.v3.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.v3.Percent overall_sampling = 5;
- Returns:
- Whether the overallSampling field is set.
-
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.v3.Percent overall_sampling = 5;
- Returns:
- The overallSampling.
-
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.v3.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;
- Returns:
- The verbose.
-
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;
- Returns:
- Whether the maxPathTagLength field is set.
-
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;
- Returns:
- The maxPathTagLength.
-
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
A list of custom tags with unique tag name to create tags for the active span.
repeated .envoy.type.tracing.v3.CustomTag custom_tags = 8;
-
getCustomTags
A list of custom tags with unique tag name to create tags for the active span.
repeated .envoy.type.tracing.v3.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.v3.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.v3.CustomTag custom_tags = 8;
-
getCustomTagsOrBuilder
A list of custom tags with unique tag name to create tags for the active span.
repeated .envoy.type.tracing.v3.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.v3.Tracing.Http provider = 9;
- Returns:
- Whether the provider field is set.
-
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.v3.Tracing.Http provider = 9;
- Returns:
- The provider.
-
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.v3.Tracing.Http provider = 9;
-
hasSpawnUpstreamSpan
boolean hasSpawnUpstreamSpan()Create separate tracing span for each upstream request if true. And if this flag is set to true, the tracing provider will assume that Envoy will be independent hop in the trace chain and may set span type to client or server based on this flag. This will deprecate the :ref:`start_child_span <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` in the router. Users should set appropriate value based on their tracing provider and actual scenario: * If Envoy is used as sidecar and users want to make the sidecar and its application as only one hop in the trace chain, this flag should be set to false. And please also make sure the :ref:`start_child_span <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` in the router is not set to true. * If Envoy is used as gateway or independent proxy, or users want to make the sidecar and its application as different hops in the trace chain, this flag should be set to true. * If tracing provider that has explicit requirements on span creation (like SkyWalking), this flag should be set to true. The default value is false for now for backward compatibility.
.google.protobuf.BoolValue spawn_upstream_span = 10;
- Returns:
- Whether the spawnUpstreamSpan field is set.
-
getSpawnUpstreamSpan
com.google.protobuf.BoolValue getSpawnUpstreamSpan()Create separate tracing span for each upstream request if true. And if this flag is set to true, the tracing provider will assume that Envoy will be independent hop in the trace chain and may set span type to client or server based on this flag. This will deprecate the :ref:`start_child_span <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` in the router. Users should set appropriate value based on their tracing provider and actual scenario: * If Envoy is used as sidecar and users want to make the sidecar and its application as only one hop in the trace chain, this flag should be set to false. And please also make sure the :ref:`start_child_span <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` in the router is not set to true. * If Envoy is used as gateway or independent proxy, or users want to make the sidecar and its application as different hops in the trace chain, this flag should be set to true. * If tracing provider that has explicit requirements on span creation (like SkyWalking), this flag should be set to true. The default value is false for now for backward compatibility.
.google.protobuf.BoolValue spawn_upstream_span = 10;
- Returns:
- The spawnUpstreamSpan.
-
getSpawnUpstreamSpanOrBuilder
com.google.protobuf.BoolValueOrBuilder getSpawnUpstreamSpanOrBuilder()Create separate tracing span for each upstream request if true. And if this flag is set to true, the tracing provider will assume that Envoy will be independent hop in the trace chain and may set span type to client or server based on this flag. This will deprecate the :ref:`start_child_span <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` in the router. Users should set appropriate value based on their tracing provider and actual scenario: * If Envoy is used as sidecar and users want to make the sidecar and its application as only one hop in the trace chain, this flag should be set to false. And please also make sure the :ref:`start_child_span <envoy_v3_api_field_extensions.filters.http.router.v3.Router.start_child_span>` in the router is not set to true. * If Envoy is used as gateway or independent proxy, or users want to make the sidecar and its application as different hops in the trace chain, this flag should be set to true. * If tracing provider that has explicit requirements on span creation (like SkyWalking), this flag should be set to true. The default value is false for now for backward compatibility.
.google.protobuf.BoolValue spawn_upstream_span = 10;
-