Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Clarify Changing Rate Limit Settings #6713

Merged
merged 12 commits into from
Oct 20, 2023
Merged

Clarify Changing Rate Limit Settings #6713

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
1ffc3b0
feature/clarify-changing-rate-limit-settings adding explanation of in…
TomerPacific Oct 14, 2023
31a7afd
Merge branch 'master' into feature/clarify-changing-rate-limit-settings
cwarnermm Oct 16, 2023
c75f234
Merge branch 'master' into feature/clarify-changing-rate-limit-settings
TomerPacific Oct 17, 2023
4b461bd
feature/clarify-changing-rate-limit-settings rewording explanations
TomerPacific Oct 17, 2023
9c3250c
Merge branch 'master' into feature/clarify-changing-rate-limit-settings
TomerPacific Oct 18, 2023
867248d
Merge branch 'master' into feature/clarify-changing-rate-limit-settings
TomerPacific Oct 18, 2023
8069cbc
feature/clarify-changing-rate-limit-settings moving explanation insid…
TomerPacific Oct 18, 2023
50ce796
Merge branch 'master' into feature/clarify-changing-rate-limit-settings
TomerPacific Oct 18, 2023
51681ba
feature/clarify-changing-rate-limit-settings moving explanations insi…
TomerPacific Oct 18, 2023
1f01f07
Merge branch 'master' into feature/clarify-changing-rate-limit-settings
TomerPacific Oct 19, 2023
dcd1d8d
Merge branch 'master' into feature/clarify-changing-rate-limit-settings
TomerPacific Oct 19, 2023
c208655
Merge branch 'master' into feature/clarify-changing-rate-limit-settings
TomerPacific Oct 20, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions source/configure/rate-limiting-configuration-settings.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
~~~~~~~~~~~~~~~~~~

Expand All @@ -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
Expand All @@ -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
~~~~~~~~~~~~~~~~~

Expand All @@ -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
Expand All @@ -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
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down