feat(limit-count): add constant key type#5984
Merged
Merged
Conversation
See apache#5881 (comment) Signed-off-by: spacewander <[email protected]>
spacewander
marked this pull request as ready for review
December 31, 2021 10:25
Member
|
cc @zaunist @leslie-tsang @guoqqqi to have a check 😄 |
takumi913
reviewed
Jan 2, 2022
Co-authored-by: Yu.Bozhong <[email protected]>
tzssangglass
approved these changes
Jan 3, 2022
bisakhmondal
approved these changes
Jan 3, 2022
| | time_window | integer | required | | time_window > 0 | the time window in seconds before the request count is reset. | | ||
| | key_type | string | optional | "var" | ["var", "var_combination"] | the type of key. | | ||
| | key_type | string | optional | "var" | ["var", "var_combination", "constant"] | the type of key. | | ||
| | key | string | optional | "remote_addr" | | the user specified key to limit the rate. If the `key_type` is "var", the key will be treated as a name of variable. If the `key_type` is "var_combination", the key will be a combination of variables. For example, if we use "$remote_addr $consumer_name" as keys, plugin will be restricted by two keys which are "remote_addr" and "consumer_name". If the value of the key is empty, `remote_addr` will be set as the default key.| |
Member
There was a problem hiding this comment.
If possible, can we add a line here[L43] to document how the key will be interpreted when the key_type is constant?
Member
Author
There was a problem hiding this comment.
Addressed in the new commit
takumi913
approved these changes
Jan 3, 2022
leslie-tsang
approved these changes
Jan 3, 2022
Signed-off-by: spacewander <[email protected]>
bisakhmondal
reviewed
Jan 3, 2022
Co-authored-by: Bisakh <[email protected]>
leslie-tsang
reviewed
Jan 3, 2022
Comment on lines
+253
to
+257
| -- here we add a separator ':' to mark the boundary of the prefix and the key itself | ||
| if not conf.group then | ||
| key = key .. ctx.conf_type .. ctx.conf_version | ||
| key = ctx.conf_type .. ctx.conf_version .. ':' .. key | ||
| else | ||
| key = key .. conf.group | ||
| key = conf.group .. ':' .. key |
Member
There was a problem hiding this comment.
I wonder if we should add a note here to alert those who use the key to monitoring or something else.
Member
Author
There was a problem hiding this comment.
Could you give an example for the note?
Member
There was a problem hiding this comment.
How about:
-- key format changed from `key*` to `*:key` for constant key type support
Member
Author
There was a problem hiding this comment.
Err...
I don't want to comment on all the changes in the code, unless it is something that affects public API. AFAIK, we don't describe the key format in the doc. So I think such change is just implementation details.
Member
There was a problem hiding this comment.
Make Sense, leave the comment here should do the trick as well.
tzssangglass
reviewed
Jan 4, 2022
Signed-off-by: spacewander <[email protected]>
kyroslin
pushed a commit
to kyroslin/apisix
that referenced
this pull request
Jan 5, 2022
Co-authored-by: Yu.Bozhong <[email protected]> Co-authored-by: Bisakh <[email protected]>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
See #5881 (comment)
Signed-off-by: spacewander [email protected]
What this PR does / why we need it:
Pre-submission checklist: