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

Class RuntimeFilter

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.accesslog.v3.RuntimeFilter
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RuntimeFilterOrBuilder, Serializable
public final class RuntimeFilter extends com.google.protobuf.GeneratedMessageV3 implements RuntimeFilterOrBuilder
 Filters requests based on runtime-configurable sampling rates.
Protobuf type envoy.config.accesslog.v3.RuntimeFilter
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    RuntimeFilter.Builder
    Filters requests based on runtime-configurable sampling rates.

    Nested 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

    Fields
    Modifier and Type
    Field
    Description
    static final int
    PERCENT_SAMPLED_FIELD_NUMBER
     
    static final int
    RUNTIME_KEY_FIELD_NUMBER
     
    static final int
    USE_INDEPENDENT_RANDOMNESS_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static RuntimeFilter
    getDefaultInstance()
     
    RuntimeFilter
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<RuntimeFilter>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    boolean
    getUseIndependentRandomness()
    Controls how sampling decisions are made
    int
    hashCode()
     
    boolean
    hasPercentSampled()
    Defines the default sampling percentage when no runtime override is present.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static RuntimeFilter.Builder
    newBuilder()
     
    static RuntimeFilter.Builder
    newBuilder(RuntimeFilter prototype)
     
    RuntimeFilter.Builder
    newBuilderForType()
     
    protected RuntimeFilter.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static RuntimeFilter
    parseDelimitedFrom(InputStream input)
     
    static RuntimeFilter
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RuntimeFilter
    parseFrom(byte[] data)
     
    static RuntimeFilter
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RuntimeFilter
    parseFrom(com.google.protobuf.ByteString data)
     
    static RuntimeFilter
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RuntimeFilter
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static RuntimeFilter
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RuntimeFilter
    parseFrom(InputStream input)
     
    static RuntimeFilter
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static RuntimeFilter
    parseFrom(ByteBuffer data)
     
    static RuntimeFilter
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<RuntimeFilter>
    parser()
     
    RuntimeFilter.Builder
    toBuilder()
     
    void
    writeTo(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, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

    • RUNTIME_KEY_FIELD_NUMBER

      public static final int RUNTIME_KEY_FIELD_NUMBER
      See Also:

    • PERCENT_SAMPLED_FIELD_NUMBER

      public static final int PERCENT_SAMPLED_FIELD_NUMBER
      See Also:

    • USE_INDEPENDENT_RANDOMNESS_FIELD_NUMBER

      public static final int USE_INDEPENDENT_RANDOMNESS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getRuntimeKey

      public 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) = { ... }
      Specified by:
      getRuntimeKey in interface RuntimeFilterOrBuilder
      Returns:
      The runtimeKey.

    • getRuntimeKeyBytes

      public 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) = { ... }
      Specified by:
      getRuntimeKeyBytes in interface RuntimeFilterOrBuilder
      Returns:
      The bytes for runtimeKey.

    • hasPercentSampled

      public 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;
      Specified by:
      hasPercentSampled in interface RuntimeFilterOrBuilder
      Returns:
      Whether the percentSampled field is set.

    • getPercentSampled

      public 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;
      Specified by:
      getPercentSampled in interface RuntimeFilterOrBuilder
      Returns:
      The percentSampled.

    • getPercentSampledOrBuilder

      public 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;
      Specified by:
      getPercentSampledOrBuilder in interface RuntimeFilterOrBuilder

    • getUseIndependentRandomness

      public 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;
      Specified by:
      getUseIndependentRandomness in interface RuntimeFilterOrBuilder
      Returns:
      The useIndependentRandomness.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RuntimeFilter parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RuntimeFilter parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RuntimeFilter parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RuntimeFilter parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RuntimeFilter parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RuntimeFilter parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RuntimeFilter parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RuntimeFilter parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RuntimeFilter parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RuntimeFilter parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RuntimeFilter parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RuntimeFilter parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RuntimeFilter.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RuntimeFilter.Builder newBuilder()

    • newBuilder

      public static RuntimeFilter.Builder newBuilder(RuntimeFilter prototype)

    • toBuilder

      public RuntimeFilter.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RuntimeFilter.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static RuntimeFilter getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RuntimeFilter> parser()

    • getParserForType

      public com.google.protobuf.Parser<RuntimeFilter> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public RuntimeFilter getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder