Clarify Changing Rate Limit Settings (#6713)

* feature/clarify-changing-rate-limit-settings adding explanation of increasing/lowering query/burst/memory * feature/clarify-changing-rate-limit-settings rewording explanations * feature/clarify-changing-rate-limit-settings moving explanation inside table * feature/clarify-changing-rate-limit-settings moving explanations inside table --------- Co-authored-by: Carrie Warner (Mattermost) <[email protected]>
mattermost · Oct 20, 2023 · 61b2f53 · 61b2f53
1 parent 39f7828
commit 61b2f53
Showing 1 changed file with 17 additions and 0 deletions.
diff --git 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,6 +57,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.
 
+
 Maximum burst size
 ~~~~~~~~~~~~~~~~~~
 
@@ -64,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
@@ -73,6 +82,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.
 
+
 Memory store size
 ~~~~~~~~~~~~~~~~~
 
@@ -85,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
@@ -96,6 +112,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.
 
+
 Vary rate limit by remote address
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~