io.envoyproxy.envoy.config.route.v3

Interface TracingOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Tracing, Tracing.Builder

public interface TracingOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
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).
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.
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	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.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

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.v3.FractionalPercent client_sampling = 1;

getClientSampling

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;

getClientSamplingOrBuilder

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;

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.FractionalPercent random_sampling = 2;

getRandomSampling

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;

getRandomSamplingOrBuilder

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;

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.FractionalPercent overall_sampling = 3;

getOverallSampling

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;

getOverallSamplingOrBuilder

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;

getCustomTagsList

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_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;

getCustomTags

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_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;

getCustomTagsCount

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_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;

getCustomTagsOrBuilderList

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_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;

getCustomTagsOrBuilder

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_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;