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.

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

Update Example 2 with details about STOP_CACHE_KEY_INCREMENT_WHEN_OVERLIMIT #837

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -370,6 +370,10 @@ The configuration also sets up another rule without a value. This one creates an
any particular number during a 1 day period. Thus, ("to_number", "2061111111") and ("to_number", "2062222222") both
get 100 requests per day.

With the out of the box configuration, if the ("message_type", "marketing"),("to_number", "2062222222") gets a 6th call,
the overall 100 messages a day will still increment. If you want to just deny the 6th marketing call without counting
against the overall limit to that number, set `STOP_CACHE_KEY_INCREMENT_WHEN_OVERLIMIT` to `true` as shown in [Redis](#redis)

When calling the rate limit service, the client can specify _multiple descriptors_ to limit on in a single call. This
limits round trips and allows limiting on aggregate rule definitions. For example, using the preceding configuration,
the client could send this complete request (in pseudo IDL):
Expand Down