Package io.envoyproxy.envoy.config.route.v3

Class RouteAction.RequestMirrorPolicy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.config.route.v3.RouteAction.RequestMirrorPolicy
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RouteAction.RequestMirrorPolicyOrBuilder, Serializable
Enclosing class:
RouteAction
public static final class RouteAction.RequestMirrorPolicy extends com.google.protobuf.GeneratedMessageV3 implements RouteAction.RequestMirrorPolicyOrBuilder
 The router is capable of shadowing traffic from one cluster to another. The current
 implementation is "fire and forget," meaning Envoy will not wait for the shadow cluster to
 respond before returning the response from the primary cluster. All normal statistics are
 collected for the shadow cluster making this feature useful for testing.

 During shadowing, the host/authority header is altered such that ``-shadow`` is appended. This is
 useful for logging. For example, ``cluster1`` becomes ``cluster1-shadow``. This behavior can be
 disabled by setting ``disable_shadow_host_suffix_append`` to ``true``.

 .. note::

   Shadowing will not be triggered if the primary cluster does not exist.

 .. note::

   Shadowing doesn't support HTTP CONNECT and upgrades.
 [#next-free-field: 9]
Protobuf type envoy.config.route.v3.RouteAction.RequestMirrorPolicy
See Also:

  • Field Details

    • CLUSTER_FIELD_NUMBER

      public static final int CLUSTER_FIELD_NUMBER
      See Also:

    • CLUSTER_HEADER_FIELD_NUMBER

      public static final int CLUSTER_HEADER_FIELD_NUMBER
      See Also:

    • RUNTIME_FRACTION_FIELD_NUMBER

      public static final int RUNTIME_FRACTION_FIELD_NUMBER
      See Also:

    • TRACE_SAMPLED_FIELD_NUMBER

      public static final int TRACE_SAMPLED_FIELD_NUMBER
      See Also:

    • DISABLE_SHADOW_HOST_SUFFIX_APPEND_FIELD_NUMBER

      public static final int DISABLE_SHADOW_HOST_SUFFIX_APPEND_FIELD_NUMBER
      See Also:

    • REQUEST_HEADERS_MUTATIONS_FIELD_NUMBER

      public static final int REQUEST_HEADERS_MUTATIONS_FIELD_NUMBER
      See Also:

    • HOST_REWRITE_LITERAL_FIELD_NUMBER

      public static final int HOST_REWRITE_LITERAL_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

    • getCluster

      public String getCluster()
       Only one of ``cluster`` and ``cluster_header`` can be specified.
 [#next-major-version: Need to add back the validation rule: (validate.rules).string = {min_len: 1}]
 Specifies the cluster that requests will be mirrored to. The cluster must
 exist in the cluster manager configuration.
      string cluster = 1 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      getCluster in interface RouteAction.RequestMirrorPolicyOrBuilder
      Returns:
      The cluster.

    • getClusterBytes

      public com.google.protobuf.ByteString getClusterBytes()
       Only one of ``cluster`` and ``cluster_header`` can be specified.
 [#next-major-version: Need to add back the validation rule: (validate.rules).string = {min_len: 1}]
 Specifies the cluster that requests will be mirrored to. The cluster must
 exist in the cluster manager configuration.
      string cluster = 1 [(.udpa.annotations.field_migrate) = { ... }
      Specified by:
      getClusterBytes in interface RouteAction.RequestMirrorPolicyOrBuilder
      Returns:
      The bytes for cluster.

    • getClusterHeader

      public String getClusterHeader()
       Only one of ``cluster`` and ``cluster_header`` can be specified.
 Envoy will determine the cluster to route to by reading the value of the
 HTTP header named by cluster_header from the request headers. Only the first value in header is used,
 and no shadow request will happen if the value is not found in headers. Envoy will not wait for
 the shadow cluster to respond before returning the response from the primary cluster.

 .. attention::

   Internally, Envoy always uses the HTTP/2 ``:authority`` header to represent the HTTP/1
   ``Host`` header. Thus, if attempting to match on ``Host``, match on ``:authority`` instead.

 .. note::

   If the header appears multiple times only the first value is used.
      string cluster_header = 5 [(.validate.rules) = { ... }
      Specified by:
      getClusterHeader in interface RouteAction.RequestMirrorPolicyOrBuilder
      Returns:
      The clusterHeader.

    • getClusterHeaderBytes

      public com.google.protobuf.ByteString getClusterHeaderBytes()
       Only one of ``cluster`` and ``cluster_header`` can be specified.
 Envoy will determine the cluster to route to by reading the value of the
 HTTP header named by cluster_header from the request headers. Only the first value in header is used,
 and no shadow request will happen if the value is not found in headers. Envoy will not wait for
 the shadow cluster to respond before returning the response from the primary cluster.

 .. attention::

   Internally, Envoy always uses the HTTP/2 ``:authority`` header to represent the HTTP/1
   ``Host`` header. Thus, if attempting to match on ``Host``, match on ``:authority`` instead.

 .. note::

   If the header appears multiple times only the first value is used.
      string cluster_header = 5 [(.validate.rules) = { ... }
      Specified by:
      getClusterHeaderBytes in interface RouteAction.RequestMirrorPolicyOrBuilder
      Returns:
      The bytes for clusterHeader.

    • hasRuntimeFraction

      public boolean hasRuntimeFraction()
       If not specified, all requests to the target cluster will be mirrored.

 If specified, this field takes precedence over the ``runtime_key`` field and requests must also
 fall under the percentage of matches indicated by this field.

 For some fraction N/D, a random number in the range [0,D) is selected. If the
 number is <= the value of the numerator N, or if the key is not present, the default
 value, the request will be mirrored.
      .envoy.config.core.v3.RuntimeFractionalPercent runtime_fraction = 3;
      Specified by:
      hasRuntimeFraction in interface RouteAction.RequestMirrorPolicyOrBuilder
      Returns:
      Whether the runtimeFraction field is set.

    • getRuntimeFraction

      public RuntimeFractionalPercent getRuntimeFraction()
       If not specified, all requests to the target cluster will be mirrored.

 If specified, this field takes precedence over the ``runtime_key`` field and requests must also
 fall under the percentage of matches indicated by this field.

 For some fraction N/D, a random number in the range [0,D) is selected. If the
 number is <= the value of the numerator N, or if the key is not present, the default
 value, the request will be mirrored.
      .envoy.config.core.v3.RuntimeFractionalPercent runtime_fraction = 3;
      Specified by:
      getRuntimeFraction in interface RouteAction.RequestMirrorPolicyOrBuilder
      Returns:
      The runtimeFraction.

    • getRuntimeFractionOrBuilder

      public RuntimeFractionalPercentOrBuilder getRuntimeFractionOrBuilder()
       If not specified, all requests to the target cluster will be mirrored.

 If specified, this field takes precedence over the ``runtime_key`` field and requests must also
 fall under the percentage of matches indicated by this field.

 For some fraction N/D, a random number in the range [0,D) is selected. If the
 number is <= the value of the numerator N, or if the key is not present, the default
 value, the request will be mirrored.
      .envoy.config.core.v3.RuntimeFractionalPercent runtime_fraction = 3;
      Specified by:
      getRuntimeFractionOrBuilder in interface RouteAction.RequestMirrorPolicyOrBuilder

    • hasTraceSampled

      public boolean hasTraceSampled()
       Specifies whether the trace span for the shadow request should be sampled. If this field is not explicitly set,
 the shadow request will inherit the sampling decision of its parent span. This ensures consistency with the trace
 sampling policy of the original request and prevents oversampling, especially in scenarios where runtime sampling
 is disabled.
      .google.protobuf.BoolValue trace_sampled = 4;
      Specified by:
      hasTraceSampled in interface RouteAction.RequestMirrorPolicyOrBuilder
      Returns:
      Whether the traceSampled field is set.

    • getTraceSampled

      public com.google.protobuf.BoolValue getTraceSampled()
       Specifies whether the trace span for the shadow request should be sampled. If this field is not explicitly set,
 the shadow request will inherit the sampling decision of its parent span. This ensures consistency with the trace
 sampling policy of the original request and prevents oversampling, especially in scenarios where runtime sampling
 is disabled.
      .google.protobuf.BoolValue trace_sampled = 4;
      Specified by:
      getTraceSampled in interface RouteAction.RequestMirrorPolicyOrBuilder
      Returns:
      The traceSampled.

    • getTraceSampledOrBuilder

      public com.google.protobuf.BoolValueOrBuilder getTraceSampledOrBuilder()
       Specifies whether the trace span for the shadow request should be sampled. If this field is not explicitly set,
 the shadow request will inherit the sampling decision of its parent span. This ensures consistency with the trace
 sampling policy of the original request and prevents oversampling, especially in scenarios where runtime sampling
 is disabled.
      .google.protobuf.BoolValue trace_sampled = 4;
      Specified by:
      getTraceSampledOrBuilder in interface RouteAction.RequestMirrorPolicyOrBuilder

    • getDisableShadowHostSuffixAppend

      public boolean getDisableShadowHostSuffixAppend()
       Disables appending the ``-shadow`` suffix to the shadowed ``Host`` header.

 Defaults to ``false``.
      bool disable_shadow_host_suffix_append = 6;
      Specified by:
      getDisableShadowHostSuffixAppend in interface RouteAction.RequestMirrorPolicyOrBuilder
      Returns:
      The disableShadowHostSuffixAppend.

    • getRequestHeadersMutationsList

      public List<HeaderMutation> getRequestHeadersMutationsList()
       Specifies a list of header mutations that should be applied to each mirrored request.
 Header mutations are applied in the order they are specified. For more information, including
 details on header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
      repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... }
      Specified by:
      getRequestHeadersMutationsList in interface RouteAction.RequestMirrorPolicyOrBuilder

    • getRequestHeadersMutationsOrBuilderList

      public List<? extends HeaderMutationOrBuilder> getRequestHeadersMutationsOrBuilderList()
       Specifies a list of header mutations that should be applied to each mirrored request.
 Header mutations are applied in the order they are specified. For more information, including
 details on header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
      repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... }
      Specified by:
      getRequestHeadersMutationsOrBuilderList in interface RouteAction.RequestMirrorPolicyOrBuilder

    • getRequestHeadersMutationsCount

      public int getRequestHeadersMutationsCount()
       Specifies a list of header mutations that should be applied to each mirrored request.
 Header mutations are applied in the order they are specified. For more information, including
 details on header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
      repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... }
      Specified by:
      getRequestHeadersMutationsCount in interface RouteAction.RequestMirrorPolicyOrBuilder

    • getRequestHeadersMutations

      public HeaderMutation getRequestHeadersMutations(int index)
       Specifies a list of header mutations that should be applied to each mirrored request.
 Header mutations are applied in the order they are specified. For more information, including
 details on header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
      repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... }
      Specified by:
      getRequestHeadersMutations in interface RouteAction.RequestMirrorPolicyOrBuilder

    • getRequestHeadersMutationsOrBuilder

      public HeaderMutationOrBuilder getRequestHeadersMutationsOrBuilder(int index)
       Specifies a list of header mutations that should be applied to each mirrored request.
 Header mutations are applied in the order they are specified. For more information, including
 details on header value syntax, see the documentation on :ref:`custom request headers
 <config_http_conn_man_headers_custom_request_headers>`.
      repeated .envoy.config.common.mutation_rules.v3.HeaderMutation request_headers_mutations = 7 [(.validate.rules) = { ... }
      Specified by:
      getRequestHeadersMutationsOrBuilder in interface RouteAction.RequestMirrorPolicyOrBuilder

    • getHostRewriteLiteral

      public String getHostRewriteLiteral()
       Indicates that during mirroring, the host header will be swapped with this value.
 :ref:`disable_shadow_host_suffix_append
 <envoy_v3_api_field_config.route.v3.RouteAction.RequestMirrorPolicy.disable_shadow_host_suffix_append>`
 is implicitly enabled if this field is set.
      string host_rewrite_literal = 8 [(.validate.rules) = { ... }
      Specified by:
      getHostRewriteLiteral in interface RouteAction.RequestMirrorPolicyOrBuilder
      Returns:
      The hostRewriteLiteral.

    • getHostRewriteLiteralBytes

      public com.google.protobuf.ByteString getHostRewriteLiteralBytes()
       Indicates that during mirroring, the host header will be swapped with this value.
 :ref:`disable_shadow_host_suffix_append
 <envoy_v3_api_field_config.route.v3.RouteAction.RequestMirrorPolicy.disable_shadow_host_suffix_append>`
 is implicitly enabled if this field is set.
      string host_rewrite_literal = 8 [(.validate.rules) = { ... }
      Specified by:
      getHostRewriteLiteralBytes in interface RouteAction.RequestMirrorPolicyOrBuilder
      Returns:
      The bytes for hostRewriteLiteral.

    • 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 RouteAction.RequestMirrorPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static RouteAction.RequestMirrorPolicy parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static RouteAction.RequestMirrorPolicy parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static RouteAction.RequestMirrorPolicy.Builder newBuilder()

    • newBuilder

      public static RouteAction.RequestMirrorPolicy.Builder newBuilder(RouteAction.RequestMirrorPolicy prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static RouteAction.RequestMirrorPolicy getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<RouteAction.RequestMirrorPolicy> 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 RouteAction.RequestMirrorPolicy getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder