docs(cloud): set the rate limit high enough for the selected template set - #242
Open
patrick-projectdiscovery wants to merge 6 commits into
Open
docs(cloud): set the rate limit high enough for the selected template set#242patrick-projectdiscovery wants to merge 6 commits into
patrick-projectdiscovery wants to merge 6 commits into
Conversation
…speed The rate limit control was documented in isolation from the per-host time budget that makes a low value dangerous. The page framed the only cost of throttling as a slower scan, recommended 10-30 req/sec as a starting point, and carried a worked example at 10 req/sec. A customer scanning the full template set at 10 req/sec silently lost every vulnerability finding: the scan hit the per-host budget after the passive templates and reported finished at 100% rather than erroring. - State the coverage consequence and the finished-at-100% symptom - Recommend 100+ req/sec for full template-set scans, and scope low values to small targeted template selections - Raise the 10 req/sec worked example and note why - Caveat applying a rate limit globally - Link the external scanning rate-limit card to the guidance Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Both 404 today. `mint broken-links` reports them. - /cloud/scanning/nuclei-scan -> /cloud/scanning/internal-scan (page renamed; the link text already says "learn more about internal scanning") - /cloud/editor/introduction -> /cloud/editor/overview (only introduction_old remains; overview is the live page other docs link to) Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Per Davis, who diagnosed the customer case: under a small rate limit only the informational templates fire. Naming that is more useful than "passive checks", because the customer's observable symptom is a completed scan reporting `info` findings only, with the Critical and High findings gone. Also points at the Recommended profile as the lever for a target that genuinely cannot take 100 req/sec, since it already excludes informational templates. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
"ProjectDiscovery offers Enterprise users gain additional features" has two verbs. Same line as the link fix in the previous commit. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Davis's review: too transparent, and it read AI.
Removed the description of a scan reporting finished at 100% after stopping at
the budget. That is a UX flaw being fixed, so it does not belong in customer
docs; the guidance stands on its own without it.
Cut the Tip and the symptom paragraph into the Warning, dropped the invented
label prefixes ("Symptom to look for", "Sizing the rate limit"), the "not just
X" construction and the trailing justifications on each bullet. The Rate
Limiting section is 763 characters against about 1,900.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
patrick-projectdiscovery
changed the title
Davis: the templates may find Critical and High issues, and can be dropped. The previous wording asserted both as certainties, which is not true of any given target. Reworked the leading clause to an if/then so his phrasing does not sit next to a second statement of the same idea. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
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
2 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.
Why
cloud/scanning/parameters.mdxis the only page documenting the per-host rate limit, and it presented a slower scan as the only cost of a low value. Scans run under a per-host time budget, so a rate limit set too low for the number of templates selected means not every template runs. The page gave no indication of that, and its guidance pointed the other way:Rate limit per host: 10What changed
cloud/scanning/parameters.mdxWarningnoting the per-host time budget, and that a rate limit too low for the selected template count drops the exploitation templates that find Critical and High issues.100requests/second or higher for full template-set scans, and to narrow the template selection to match where a host cannot take that. Points at the Recommended profile, which excludes informational templates.10-30requests/second Best Practices guideline, raised the10worked example, and noted that a globally applied rate limit reaches every scan.cloud/scanning/external-scan.mdxmint broken-links:/cloud/scanning/nuclei-scanto/cloud/scanning/internal-scan(page renamed; the link text already says "internal scanning"), and/cloud/editor/introductionto/cloud/editor/overview.Checks
mint broken-linksclean on both pages, including the new#rate-limitinganchor and the Recommended profile link. The external scanning page went from 2 broken links to 0. JSX components balanced; both pages present inmint.json.🤖 Generated with Claude Code