chore: DOS protection of non-relay req/resp protocols new cli argument description #216
Conversation
This file contains 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
…, now described officially.
NagyZoltanPeter
requested review from
jm-clius,
gabrielmer,
fryorcraken and
Ivansete-status
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
jm-clius
approved these changes
Sep 18, 2024
docs/guides/nwaku/config-options.md
Outdated
|
|
||
| | Name | Default Value | Description | | ||
| | ---------------------------- | ------------- | ------------------------------------------------------ | | ||
| | <nobr>`rate-limit`</nobr> | | This is a repeatable option. Each one of them can describe spefic rate limit configuration for a particular protocol.<br>\<protocol\>:volume/period\<time-unit\><br>- if protocol is not given, settings will be taken as default for un-set protocols. Ex: `80/2s`<br>-Supported protocols are: `lightpush`\|`filter`\|`px`\|`store`\|`storev2`\|`storev3`<br>-volume must be an integer value, representing number of requests over the period of time allowed.<br>-period\<time-unit\> must be an integer with defined unit as one of `h`\|`m`\|`s`\|`ms`<br>- `storev2` and `storev3` takes precedence over `store` which can easy set both store protocols at once.<br>- In case of multiple set of the same protocol limit, last one will take place.<br>- if config is not set it means unlimited requests are allowed.<br>-filter has a bit different approach. It has a default setting applied if not overridden. Rate limit setting for filter will be applied per subscriber-peers, not globally - it must be considered when changing the setting.<br><br>Examples:<br>- `100/1s` - default for all protocols if not set otherwise.<br>-`lightpush:0/0s` - lightpush protocol will be not rate limited.<br>-`store:130/1500ms` - both store-v3 and store-v2 will apply 130 request per each 1500ms separately.<br>-`px:10/1h` PeerExchange will serve only 10 requests in every hour.<br>-`filter:8/5m` - will allow 8 subs/unsubs/ping requests for each subscribers within every 5 min. | |
There was a problem hiding this comment.
Do we really need the storev2 and storev3 differentiation? I would hide this complexity, especially since we plan to deprecate storev2 completely, soon. I would simply allow a single configuration option here for store that sets the rate limit for both protocols.
There was a problem hiding this comment.
I see. Currently for status we are using both protocol and they have very different loads so it is inconvenient to describe them similar rate limits. It was the original idea behind the distinction.
Would it be ok, to remove it whit the removal of legacy store protocol?
fryorcraken
reviewed
Sep 30, 2024
|
|
||
| | Name | Default Value | Description | | ||
| | ---------------------------- | ------------- | ------------------------------------------------------ | | ||
| | `rate-limit` | | This is a repeatable option. Each one of them can describe spefic rate limit configuration for a particular protocol.<br />\<protocol\>:volume/period\<time-unit\><br />- if protocol is not given, settings will be taken as default for un-set protocols. Ex: `80/2s`<br />-Supported protocols are: `lightpush`\|`filter`\|`px`\|`store`\|`storev2`\|`storev3`<br />-volume must be an integer value, representing number of requests over the period of time allowed.<br />-period\<time-unit\> must be an integer with defined unit as one of `h`\|`m`\|`s`\|`ms`<br />- `storev2` and `storev3` takes precedence over `store` which can easy set both store protocols at once.<br />- In case of multiple set of the same protocol limit, last one will take place.<br />- if config is not set it means unlimited requests are allowed.<br />-filter has a bit different approach. It has a default setting applied if not overridden. Rate limit setting for filter will be applied per subscriber-peers, not globally - it must be considered when changing the setting.<br /><br />Examples:<br />- `100/1s` - default for all protocols if not set otherwise.<br />-`lightpush:0/0s` - lightpush protocol will be not rate limited.<br />-`store:130/1500ms` - both store-v3 and store-v2 will apply 130 request per each 1500ms separately.<br />-`px:10/1h` PeerExchange will serve only 10 requests in every hour.<br />-`filter:8/5m` - will allow 8 subs/unsubs/ping requests for each subscribers within every 5 min. | |
There was a problem hiding this comment.
spefic
specific
<protocol>:volume/period<time-unit>
I'd wrap that in backticks "`"
There was a problem hiding this comment.
what's the default value?
fryorcraken
pushed a commit
to 666devs/docs.waku.org
that referenced
this pull request
Oct 1, 2024
…t description (waku-org#216) * DOS protection of non-relay req/resp protocols has a new cli argument, now described officially.
danisharora099
pushed a commit
that referenced
this pull request
Oct 1, 2024
…t description (#216) * DOS protection of non-relay req/resp protocols has a new cli argument, now described officially.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is part of waku-org/nwaku#3035 and waku-org/nwaku#3028.
PM: waku-org/pm#66 deliverable.
This PR adds description of
--rate-limitcli option and exact usage.