Class Tracing
java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.route.v3.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
[#next-free-field: 7]Protobuf type
envoy.config.route.v3.Tracing- See Also:
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT, BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, 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 -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final intstatic final intstatic final intstatic final intstatic final intstatic final intFields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFieldsFields inherited from class com.google.protobuf.AbstractMessage
memoizedSizeFields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode -
Method Summary
Modifier and TypeMethodDescriptionbooleanTarget 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.intA 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.static Tracingstatic final com.google.protobuf.Descriptors.DescriptorThe operation name of the span which will be used for tracing.com.google.protobuf.ByteStringThe operation name of the span which will be used for tracing.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).com.google.protobuf.Parser<Tracing>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.intThe operation name of the upstream span which will be used for tracing.com.google.protobuf.ByteStringThe operation name of the upstream span which will be used for tracing.booleanTarget 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.inthashCode()booleanTarget 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).booleanTarget 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.FieldAccessorTablefinal booleanstatic Tracing.Builderstatic Tracing.BuildernewBuilder(Tracing prototype) protected Tracing.BuildernewBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) protected ObjectnewInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused) static TracingparseDelimitedFrom(InputStream input) static TracingparseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TracingparseFrom(byte[] data) static TracingparseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TracingparseFrom(com.google.protobuf.ByteString data) static TracingparseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TracingparseFrom(com.google.protobuf.CodedInputStream input) static TracingparseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TracingparseFrom(InputStream input) static TracingparseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static TracingparseFrom(ByteBuffer data) static TracingparseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) static com.google.protobuf.Parser<Tracing>parser()voidwriteTo(com.google.protobuf.CodedOutputStream output) Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, 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, writeStringNoTagMethods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toStringMethods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeToMethods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof
-
Field Details
-
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:
-
CUSTOM_TAGS_FIELD_NUMBER
public static final int CUSTOM_TAGS_FIELD_NUMBER- See Also:
-
OPERATION_FIELD_NUMBER
public static final int OPERATION_FIELD_NUMBER- See Also:
-
UPSTREAM_OPERATION_FIELD_NUMBER
public static final int UPSTREAM_OPERATION_FIELD_NUMBER- See Also:
-
-
Method Details
-
newInstance
- Overrides:
newInstancein classcom.google.protobuf.GeneratedMessageV3
-
getDescriptor
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor() -
internalGetFieldAccessorTable
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()- Specified by:
internalGetFieldAccessorTablein classcom.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_enabled' in the :ref:`HTTP Connection Manager <config_http_conn_man_runtime>`. Default: 100%
.envoy.type.v3.FractionalPercent client_sampling = 1;- Specified by:
hasClientSamplingin interfaceTracingOrBuilder- Returns:
- Whether the clientSampling field is set.
-
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.FractionalPercent client_sampling = 1;- Specified by:
getClientSamplingin interfaceTracingOrBuilder- Returns:
- The clientSampling.
-
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.FractionalPercent client_sampling = 1;- Specified by:
getClientSamplingOrBuilderin interfaceTracingOrBuilder
-
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:
hasRandomSamplingin interfaceTracingOrBuilder- Returns:
- Whether the randomSampling field is set.
-
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:
getRandomSamplingin interfaceTracingOrBuilder- Returns:
- The randomSampling.
-
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:
getRandomSamplingOrBuilderin interfaceTracingOrBuilder
-
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:
hasOverallSamplingin interfaceTracingOrBuilder- Returns:
- Whether the overallSampling field is set.
-
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:
getOverallSamplingin interfaceTracingOrBuilder- Returns:
- The overallSampling.
-
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:
getOverallSamplingOrBuilderin interfaceTracingOrBuilder
-
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:
getCustomTagsListin interfaceTracingOrBuilder
-
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:
getCustomTagsOrBuilderListin interfaceTracingOrBuilder
-
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:
getCustomTagsCountin interfaceTracingOrBuilder
-
getCustomTags
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:
getCustomTagsin interfaceTracingOrBuilder
-
getCustomTagsOrBuilder
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:
getCustomTagsOrBuilderin interfaceTracingOrBuilder
-
getOperation
The operation name of the span which will be used for tracing. The same :ref:`format specifier <config_access_log_format>` as used for :ref:`HTTP access logging <config_access_log>` applies here, however unknown specifier values are replaced with the empty string instead of ``-``. This field will take precedence over and make following settings ineffective: * :ref:`route decorator <envoy_v3_api_field_config.route.v3.Route.decorator>`. * :ref:`x-envoy-decorator-operation <config_http_filters_router_x-envoy-decorator-operation>`. * :ref:`HCM tracing operation <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.operation>`.
string operation = 5;- Specified by:
getOperationin interfaceTracingOrBuilder- Returns:
- The operation.
-
getOperationBytes
public com.google.protobuf.ByteString getOperationBytes()The operation name of the span which will be used for tracing. The same :ref:`format specifier <config_access_log_format>` as used for :ref:`HTTP access logging <config_access_log>` applies here, however unknown specifier values are replaced with the empty string instead of ``-``. This field will take precedence over and make following settings ineffective: * :ref:`route decorator <envoy_v3_api_field_config.route.v3.Route.decorator>`. * :ref:`x-envoy-decorator-operation <config_http_filters_router_x-envoy-decorator-operation>`. * :ref:`HCM tracing operation <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.operation>`.
string operation = 5;- Specified by:
getOperationBytesin interfaceTracingOrBuilder- Returns:
- The bytes for operation.
-
getUpstreamOperation
The operation name of the upstream span which will be used for tracing. This only takes effect when ``spawn_upstream_span`` is set to true and the upstream span is created. The same :ref:`format specifier <config_access_log_format>` as used for :ref:`HTTP access logging <config_access_log>` applies here, however unknown specifier values are replaced with the empty string instead of ``-``. This field will take precedence over and make following settings ineffective: * :ref:`HCM tracing upstream operation <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.upstream_operation>`
string upstream_operation = 6;- Specified by:
getUpstreamOperationin interfaceTracingOrBuilder- Returns:
- The upstreamOperation.
-
getUpstreamOperationBytes
public com.google.protobuf.ByteString getUpstreamOperationBytes()The operation name of the upstream span which will be used for tracing. This only takes effect when ``spawn_upstream_span`` is set to true and the upstream span is created. The same :ref:`format specifier <config_access_log_format>` as used for :ref:`HTTP access logging <config_access_log>` applies here, however unknown specifier values are replaced with the empty string instead of ``-``. This field will take precedence over and make following settings ineffective: * :ref:`HCM tracing upstream operation <envoy_v3_api_field_extensions.filters.network.http_connection_manager.v3.HttpConnectionManager.Tracing.upstream_operation>`
string upstream_operation = 6;- Specified by:
getUpstreamOperationBytesin interfaceTracingOrBuilder- Returns:
- The bytes for upstreamOperation.
-
isInitialized
public final boolean isInitialized()- Specified by:
isInitializedin interfacecom.google.protobuf.MessageLiteOrBuilder- Overrides:
isInitializedin classcom.google.protobuf.GeneratedMessageV3
-
writeTo
- Specified by:
writeToin interfacecom.google.protobuf.MessageLite- Overrides:
writeToin classcom.google.protobuf.GeneratedMessageV3- Throws:
IOException
-
getSerializedSize
public int getSerializedSize()- Specified by:
getSerializedSizein interfacecom.google.protobuf.MessageLite- Overrides:
getSerializedSizein classcom.google.protobuf.GeneratedMessageV3
-
equals
- Specified by:
equalsin interfacecom.google.protobuf.Message- Overrides:
equalsin classcom.google.protobuf.AbstractMessage
-
hashCode
public int hashCode()- Specified by:
hashCodein interfacecom.google.protobuf.Message- Overrides:
hashCodein classcom.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
- Throws:
IOException
-
parseFrom
public static Tracing parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseDelimitedFrom
- Throws:
IOException
-
parseDelimitedFrom
public static Tracing parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
parseFrom
- Throws:
IOException
-
parseFrom
public static Tracing parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException - Throws:
IOException
-
newBuilderForType
- Specified by:
newBuilderForTypein interfacecom.google.protobuf.Message- Specified by:
newBuilderForTypein interfacecom.google.protobuf.MessageLite
-
newBuilder
-
newBuilder
-
toBuilder
- Specified by:
toBuilderin interfacecom.google.protobuf.Message- Specified by:
toBuilderin interfacecom.google.protobuf.MessageLite
-
newBuilderForType
protected Tracing.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent) - Specified by:
newBuilderForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstance
-
parser
-
getParserForType
- Specified by:
getParserForTypein interfacecom.google.protobuf.Message- Specified by:
getParserForTypein interfacecom.google.protobuf.MessageLite- Overrides:
getParserForTypein classcom.google.protobuf.GeneratedMessageV3
-
getDefaultInstanceForType
- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageLiteOrBuilder- Specified by:
getDefaultInstanceForTypein interfacecom.google.protobuf.MessageOrBuilder
-