Skip to content

Commit 99581b1

Browse files
committed
doc changes
1 parent 87bfb90 commit 99581b1

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

doc/sphinx-guides/source/admin/rate_limiting.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Rate limiting can be configured on a tier level with tier 0 being reserved for g
1212
Superuser accounts are exempt from rate limiting.
1313
Rate limits can be imposed on command APIs by configuring the tier, the command, and the hourly limit in the database.
1414
Two database settings configure the rate limiting.
15-
Note: If either of these settings exist in the database rate limiting will be enabled (note that a Payara restart is required for the setting to take effect). If neither setting exists rate limiting is disabled.
15+
Note: If either of these settings exist in the database rate limiting will be enabled (note that a Payara restart is required for the :RateLimitingDefaultCapacityTiers setting to take effect). If neither setting exists rate limiting is disabled.
1616

1717
- :RateLimitingDefaultCapacityTiers is the number of calls allowed per hour if the specific command is not configured. The values represent the number of calls per hour per user for tiers 0,1,...
1818
A value of -1 can be used to signify no rate limit. Tiers not specified in this setting will default to `-1` (No Limit). I.e., -d "10000" is equivalent to -d "10000,-1,-1,..."
@@ -33,10 +33,13 @@ Note: If either of these settings exist in the database rate limiting will be en
3333
Statistics
3434
----------
3535

36-
In order to monitor the rate limiting cache for investigative purposes there is a stats endpoint which returns CSV formatted text. The CSV contains multiple lists.
37-
The first list contains the username:command, and number of tokens remaining. This list is sorted by the values and has the header "#<username>:<command>, <available tokens>".
38-
The second list contains username:command, last updated timestamp in minutes, and delta minutes before now. The header for this list is "#<username>:<command>, <timestamp>, <delta minutes> ## deltaMinutesFilter=1".
39-
This list can be filtered to show only the entries with updates within the deltaMinutesFilter requested. ("## deltaMinutesFilter=n" will be added to the header when the filter is included in the call.
36+
In order to monitor the rate limiting cache for investigative purposes there is a stats endpoint which returns CSV formatted text.
37+
38+
The CSV contains multiple lists.
39+
40+
- The first list contains the username:command, and number of tokens remaining. This list is sorted by the values and has the header "#<username>:<command>, <available tokens>".
41+
42+
- The second list contains username:command, last updated timestamp in minutes, and delta minutes before now. The header for this list is "#<username>:<command>, <timestamp>, <delta minutes> ## deltaMinutesFilter=1". This list can be filtered to show only the entries with updates within the deltaMinutesFilter requested. ("## deltaMinutesFilter=n" will be added to the header when the filter is included in the call.
4043

4144
.. code-block:: bash
4245

0 commit comments

Comments
 (0)