From aac8bc69ad090e26ac1376d504712a828eaeb7bc Mon Sep 17 00:00:00 2001 From: Alexy Van Den Abele <103523876+Alexy-vda@users.noreply.github.com> Date: Wed, 4 Jun 2025 11:18:04 +0200 Subject: [PATCH] Clarify mirroring service default percent value --- .../routing-configuration/http/load-balancing/service.md | 6 ++++++ docs/content/routing/services/index.md | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/docs/content/reference/routing-configuration/http/load-balancing/service.md b/docs/content/reference/routing-configuration/http/load-balancing/service.md index eaa665417..58a818ac8 100644 --- a/docs/content/reference/routing-configuration/http/load-balancing/service.md +++ b/docs/content/reference/routing-configuration/http/load-balancing/service.md @@ -265,6 +265,10 @@ http: The mirroring is able to mirror requests sent to a service to other services. Please note that by default the whole request is buffered in memory while it is being mirrored. See the `maxBodySize` option in the example below for how to modify this behaviour. You can also omit the request body by setting the `mirrorBody` option to false. +!!! warning "Default behavior of `percent`" + + When configuring a `mirror` service, if the `percent` field is not set, it defaults to `0`, meaning **no traffic will be sent to the mirror**. + !!! info "Supported Providers" This strategy can be defined currently with the [File](../../../install-configuration/providers/others/file.md) or [IngressRoute](../../../install-configuration/providers/kubernetes/kubernetes-ingress.md) providers. @@ -285,6 +289,8 @@ http: maxBodySize: 1024 mirrors: - name: appv2 + # Percent defines the percentage of requests that should be mirrored. + # Default value is 0, which means no traffic will be sent to the mirror. percent: 10 appv1: diff --git a/docs/content/routing/services/index.md b/docs/content/routing/services/index.md index 199fb81a3..9c7f76775 100644 --- a/docs/content/routing/services/index.md +++ b/docs/content/routing/services/index.md @@ -1259,6 +1259,10 @@ Please note that by default the whole request is buffered in memory while it is See the maxBodySize option in the example below for how to modify this behaviour. You can also omit the request body by setting the mirrorBody option to `false`. +!!! warning "Default behavior of `percent`" + + When configuring a `mirror` service, if the `percent` field is not set, it defaults to `0`, meaning **no traffic will be sent to the mirror**. + !!! info "Supported Providers" This strategy can be defined currently with the [File](../../providers/file.md) or [IngressRoute](../../providers/kubernetes-crd.md) providers. @@ -1279,6 +1283,8 @@ http: maxBodySize: 1024 mirrors: - name: appv2 + # Percent defines the percentage of requests that should be mirrored. + # Default value is 0, which means no traffic will be sent to the mirror. percent: 10 appv1: