Package io.envoyproxy.envoy.config.accesslog.v3

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 Type
    Method
    Description
    FractionalPercent
    getPercentSampled()
    Defines the default sampling percentage when no runtime override is present.
    FractionalPercentOrBuilder
    getPercentSampledOrBuilder()
    Defines the default sampling percentage when no runtime override is present.
    String
    getRuntimeKey()
    Specifies a key used to look up a custom sampling rate from the runtime configuration.
    com.google.protobuf.ByteString
    getRuntimeKeyBytes()
    Specifies a key used to look up a custom sampling rate from the runtime configuration.
    boolean
    getUseIndependentRandomness()
    Controls how sampling decisions are made
    boolean
    hasPercentSampled()
    Defines the default sampling percentage when no runtime override is present.

    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()
       Specifies a key used to look up a custom sampling rate from the runtime configuration. If a value is found for this
 key, it will override the default sampling rate specified in ``percent_sampled``.
      string runtime_key = 1 [(.validate.rules) = { ... }
      Returns:
      The runtimeKey.

    • getRuntimeKeyBytes

      com.google.protobuf.ByteString getRuntimeKeyBytes()
       Specifies a key used to look up a custom sampling rate from the runtime configuration. If a value is found for this
 key, it will override the default sampling rate specified in ``percent_sampled``.
      string runtime_key = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for runtimeKey.

    • hasPercentSampled

      boolean hasPercentSampled()
       Defines the default sampling percentage when no runtime override is present. If not specified, the default is
 **0%** (with a denominator of 100).
      .envoy.type.v3.FractionalPercent percent_sampled = 2;
      Returns:
      Whether the percentSampled field is set.

    • getPercentSampled

      FractionalPercent getPercentSampled()
       Defines the default sampling percentage when no runtime override is present. If not specified, the default is
 **0%** (with a denominator of 100).
      .envoy.type.v3.FractionalPercent percent_sampled = 2;
      Returns:
      The percentSampled.

    • getPercentSampledOrBuilder

      FractionalPercentOrBuilder getPercentSampledOrBuilder()
       Defines the default sampling percentage when no runtime override is present. If not specified, the default is
 **0%** (with a denominator of 100).
      .envoy.type.v3.FractionalPercent percent_sampled = 2;

    • getUseIndependentRandomness

      boolean getUseIndependentRandomness()
       Controls how sampling decisions are made.

 - Default behavior (``false``):

   * Uses the :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` as a consistent sampling pivot.
   * When :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` is present, sampling will be consistent
     across multiple hosts based on both the ``runtime_key`` and
     :ref:`x-request-id<config_http_conn_man_headers_x-request-id>`.
   * Useful for tracking related requests across a distributed system.

 - When set to ``true`` or :ref:`x-request-id<config_http_conn_man_headers_x-request-id>` is missing:

   * Sampling decisions are made randomly based only on the ``runtime_key``.
   * Useful in complex filter configurations (like nested
     :ref:`AndFilter<envoy_v3_api_msg_config.accesslog.v3.AndFilter>`/
     :ref:`OrFilter<envoy_v3_api_msg_config.accesslog.v3.OrFilter>` blocks) where independent probability
     calculations are desired.
   * Can be used to implement logging kill switches with predictable probability distributions.
      bool use_independent_randomness = 3;
      Returns:
      The useIndependentRandomness.