Interface RuntimeFilterOrBuilder
- All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
,com.google.protobuf.MessageOrBuilder
- All Known Implementing Classes:
RuntimeFilter
,RuntimeFilter.Builder
public interface RuntimeFilterOrBuilder
extends com.google.protobuf.MessageOrBuilder
-
Method Summary
Modifier and TypeMethodDescriptionThe default sampling percentage.The default sampling percentage.Runtime key to get an optional overridden numerator for use in the ``percent_sampled`` field.com.google.protobuf.ByteString
Runtime key to get an optional overridden numerator for use in the ``percent_sampled`` field.boolean
By default, sampling pivots on the header :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` being present.boolean
The default sampling percentage.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
-
getRuntimeKey
String getRuntimeKey()Runtime key to get an optional overridden numerator for use in the ``percent_sampled`` field. If found in runtime, this value will replace the default numerator.
string runtime_key = 1 [(.validate.rules) = { ... }
- Returns:
- The runtimeKey.
-
getRuntimeKeyBytes
com.google.protobuf.ByteString getRuntimeKeyBytes()Runtime key to get an optional overridden numerator for use in the ``percent_sampled`` field. If found in runtime, this value will replace the default numerator.
string runtime_key = 1 [(.validate.rules) = { ... }
- Returns:
- The bytes for runtimeKey.
-
hasPercentSampled
boolean hasPercentSampled()The default sampling percentage. If not specified, defaults to 0% with denominator of 100.
.envoy.type.v3.FractionalPercent percent_sampled = 2;
- Returns:
- Whether the percentSampled field is set.
-
getPercentSampled
FractionalPercent getPercentSampled()The default sampling percentage. If not specified, defaults to 0% with denominator of 100.
.envoy.type.v3.FractionalPercent percent_sampled = 2;
- Returns:
- The percentSampled.
-
getPercentSampledOrBuilder
FractionalPercentOrBuilder getPercentSampledOrBuilder()The default sampling percentage. If not specified, defaults to 0% with denominator of 100.
.envoy.type.v3.FractionalPercent percent_sampled = 2;
-
getUseIndependentRandomness
boolean getUseIndependentRandomness()By default, sampling pivots on the header :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` being present. If :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` is present, the filter will consistently sample across multiple hosts based on the runtime key value and the value extracted from :ref:`x-request-id<config_http_conn_man_headers_x-request-id>`. If it is missing, or ``use_independent_randomness`` is set to true, the filter will randomly sample based on the runtime key value alone. ``use_independent_randomness`` can be used for logging kill switches within complex nested :ref:`AndFilter <envoy_v3_api_msg_config.accesslog.v3.AndFilter>` and :ref:`OrFilter <envoy_v3_api_msg_config.accesslog.v3.OrFilter>` blocks that are easier to reason about from a probability perspective (i.e., setting to true will cause the filter to behave like an independent random variable when composed within logical operator filters).
bool use_independent_randomness = 3;
- Returns:
- The useIndependentRandomness.
-