From 1ffc3b0e37868cf51cd709e202f128daafb67402 Mon Sep 17 00:00:00 2001 From: unknown Date: Sat, 14 Oct 2023 17:04:40 +0300 Subject: [PATCH 1/4] feature/clarify-changing-rate-limit-settings adding explanation of increasing/lowering query/burst/memory --- source/configure/rate-limiting-configuration-settings.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/source/configure/rate-limiting-configuration-settings.rst b/source/configure/rate-limiting-configuration-settings.rst index ae05f2b5dc1..c4f7eac3dfd 100644 --- a/source/configure/rate-limiting-configuration-settings.rst +++ b/source/configure/rate-limiting-configuration-settings.rst @@ -53,6 +53,8 @@ Maximum queries per second :environment: MM_RATELIMITSETTINGS_MAXBURST :description: The maximum number of requests allowed beyond the per second query limit when `rate limiting <#enable-rate-limiting>`__ is enabled. Default is **100** requests. + If the configuration for maximum queries per second is altered it will impact if more/less queries will occur in one-second periods. + Maximum burst size ~~~~~~~~~~~~~~~~~~ @@ -73,6 +75,8 @@ Maximum burst size :environment: MM_RATELIMITSETTINGS_MEMORYSTORESIZE :description: The maximum number of user sessions connected to the system as determined by vary rate limit settings when `rate limiting <#enable-rate-limiting>`__ is enabled. Default is **10000** sessions. + If the configuration for maximum burst size is altered it will impact if more/less concurrent requests are handled. + Memory store size ~~~~~~~~~~~~~~~~~ @@ -96,6 +100,10 @@ Memory store size - **true**: **(Default)** Rate limit API access by IP address. Recommended when using a proxy. - **false**: Rate limiting does not vary by IP address. + If the configuration for memory store size is lower than the amount of users in the system, there might be too frequent session/token evications + If the configuration for memory store size is higher than the amount of users in the system, there will be an underutilization of resources + + Vary rate limit by remote address ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 4b461bd832e93db2093a95c25f66e2f387570327 Mon Sep 17 00:00:00 2001 From: unknown Date: Tue, 17 Oct 2023 20:51:38 +0300 Subject: [PATCH 2/4] feature/clarify-changing-rate-limit-settings rewording explanations --- source/configure/rate-limiting-configuration-settings.rst | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/source/configure/rate-limiting-configuration-settings.rst b/source/configure/rate-limiting-configuration-settings.rst index c4f7eac3dfd..78e87c5a863 100644 --- a/source/configure/rate-limiting-configuration-settings.rst +++ b/source/configure/rate-limiting-configuration-settings.rst @@ -53,7 +53,7 @@ Maximum queries per second :environment: MM_RATELIMITSETTINGS_MAXBURST :description: The maximum number of requests allowed beyond the per second query limit when `rate limiting <#enable-rate-limiting>`__ is enabled. Default is **100** requests. - If the configuration for maximum queries per second is altered it will impact if more/less queries will occur in one-second periods. + Increase this value to accept more requests each second, and decrease this value to allow fewer requests. Maximum burst size ~~~~~~~~~~~~~~~~~~ @@ -75,7 +75,7 @@ Maximum burst size :environment: MM_RATELIMITSETTINGS_MEMORYSTORESIZE :description: The maximum number of user sessions connected to the system as determined by vary rate limit settings when `rate limiting <#enable-rate-limiting>`__ is enabled. Default is **10000** sessions. - If the configuration for maximum burst size is altered it will impact if more/less concurrent requests are handled. + Increase this value to allow for more concurrent requests to be handled, and decrease this value to limit this capacity. Memory store size ~~~~~~~~~~~~~~~~~ @@ -100,9 +100,7 @@ Memory store size - **true**: **(Default)** Rate limit API access by IP address. Recommended when using a proxy. - **false**: Rate limiting does not vary by IP address. - If the configuration for memory store size is lower than the amount of users in the system, there might be too frequent session/token evications - If the configuration for memory store size is higher than the amount of users in the system, there will be an underutilization of resources - + We recommend setting this value to the expected number of users. A higher value may result in underutilized resources, and a lower value may result in user sessions/tokens expiring too frequently. Vary rate limit by remote address ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ From 8069cbcc4a2c6a8b4990fd15512306ad292da86e Mon Sep 17 00:00:00 2001 From: unknown Date: Wed, 18 Oct 2023 20:26:26 +0300 Subject: [PATCH 3/4] feature/clarify-changing-rate-limit-settings moving explanation inside table --- source/configure/rate-limiting-configuration-settings.rst | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/source/configure/rate-limiting-configuration-settings.rst b/source/configure/rate-limiting-configuration-settings.rst index 78e87c5a863..b85bad03cf7 100644 --- a/source/configure/rate-limiting-configuration-settings.rst +++ b/source/configure/rate-limiting-configuration-settings.rst @@ -44,6 +44,10 @@ Maximum queries per second | `rate limiting <#enable-rate-limiting>`__ is enabled. | - ``config.json`` setting: ``".RateLimitSettings.PerSec: 10,`` | | | - Environment variable: ``MM_RATELIMITSETTINGS_PERSEC`` | | Numerical input. Default is **10**. | | +| | | +| Increase this value to accept more requests each second, and | | +| decrease this value to allow fewer requests. | | +| | | +---------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: ratelimit-maxburst @@ -53,7 +57,6 @@ Maximum queries per second :environment: MM_RATELIMITSETTINGS_MAXBURST :description: The maximum number of requests allowed beyond the per second query limit when `rate limiting <#enable-rate-limiting>`__ is enabled. Default is **100** requests. - Increase this value to accept more requests each second, and decrease this value to allow fewer requests. Maximum burst size ~~~~~~~~~~~~~~~~~~ From 51681ba07a15d2fa6519a52501beea5b679f1019 Mon Sep 17 00:00:00 2001 From: unknown Date: Wed, 18 Oct 2023 21:14:21 +0300 Subject: [PATCH 4/4] feature/clarify-changing-rate-limit-settings moving explanations inside table --- .../rate-limiting-configuration-settings.rst | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/source/configure/rate-limiting-configuration-settings.rst b/source/configure/rate-limiting-configuration-settings.rst index b85bad03cf7..52b39618cc8 100644 --- a/source/configure/rate-limiting-configuration-settings.rst +++ b/source/configure/rate-limiting-configuration-settings.rst @@ -69,6 +69,10 @@ Maximum burst size | is enabled. | - Environment variable: ``MM_RATELIMITSETTINGS_MAXBURST`` | | | | | Numerical input. Default is **100**. | | +| | | +| Increase this value to allow for more concurrent requests to be | | +| handled, and decrease this value to limit this capacity. | | +| | | +-----------------------------------------------------------------+--------------------------------------------------------------------------+ .. config:setting:: ratelimit-memorystoresize @@ -78,7 +82,6 @@ Maximum burst size :environment: MM_RATELIMITSETTINGS_MEMORYSTORESIZE :description: The maximum number of user sessions connected to the system as determined by vary rate limit settings when `rate limiting <#enable-rate-limiting>`__ is enabled. Default is **10000** sessions. - Increase this value to allow for more concurrent requests to be handled, and decrease this value to limit this capacity. Memory store size ~~~~~~~~~~~~~~~~~ @@ -92,6 +95,12 @@ Memory store size | | | | Numerical input. Default is **10000**. Typically set to the | | | number of users in the system. | | +| | | +| We recommend setting this value to the expected number of | | +| users. A higher value may result in underutilized resources, | | +| and a lower value may result in user sessions/tokens expiring | | +| too frequently. | | +| | | | +-----------------------------------------------------------------+----------------------------------------------------------------------------+ .. config:setting:: ratelimit-varybyremoteaddress @@ -103,7 +112,6 @@ Memory store size - **true**: **(Default)** Rate limit API access by IP address. Recommended when using a proxy. - **false**: Rate limiting does not vary by IP address. - We recommend setting this value to the expected number of users. A higher value may result in underutilized resources, and a lower value may result in user sessions/tokens expiring too frequently. Vary rate limit by remote address ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~