Skip to content

[WAF] Improve managed rules troubleshooting: payload logging and malicious uploads#31683

Open
zeinjaber wants to merge 1 commit into
productionfrom
zein/dee-3647-managed-rules-troubleshooting
Open

[WAF] Improve managed rules troubleshooting: payload logging and malicious uploads#31683
zeinjaber wants to merge 1 commit into
productionfrom
zein/dee-3647-managed-rules-troubleshooting

Conversation

@zeinjaber

Copy link
Copy Markdown
Collaborator

Resolves DEE-3647.

Adds two pieces of guidance to the WAF managed rules troubleshooting page that were missing from the page:

  • Payload logging (false positives): tells readers to use payload logging to see which part of a request matched a rule, and to configure it ahead of time so the payload is captured for the next investigation. Links to the payload logging overview and the dashboard configuration page. Notes it is Enterprise-only.
  • Malicious uploads / binary content (false positives, Additional recommendations): explains that managed rulesets inspect standard HTTP content, that binary uploads can cause false positives, and points to Malicious uploads detection for scanning file uploads.

Intentionally not changed

The ticket also suggested adding WAF attack score guidance for false negatives and clarifying exception-vs-disable behavior. Both are already documented on this page (the Troubleshoot false negatives section already recommends WAF attack score, and the Troubleshoot false positives section already covers exceptions vs disabling rules), so they were left as-is to avoid duplication.

Notes

  • Docs-only change; no product/runtime changes.
  • All internal links verified against existing pages.

@github-actions

Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/docs/waf/ @pedrosousa, @cloudflare/firewall, @cloudflare/appsec-reviewers, @elithrar, @cloudflare/product-owners, @hsaxenaCF, @danielegm

@ask-bonk

ask-bonk Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

PR Review for #31683

Summary

This PR makes a clean, docs-only change to src/content/docs/waf/managed-rules/troubleshooting.mdx by adding two pieces of missing guidance:

  1. Payload logging for false positives — A new paragraph under Troubleshoot false positives recommends enabling payload logging to identify the exact request content that triggered a managed rule. It links to the payload logging overview and dashboard configuration pages and notes the Enterprise plan restriction.
  2. Binary uploads / Malicious uploads — A new bullet under Additional recommendations explains that binary uploads (e.g., file uploads) can cause false positives in managed rulesets, and points users to the Malicious uploads detection feature.

The additions are well-placed, the links are valid, and no new components or frontmatter changes are required.

Suggested Labels

  • product:waf
  • documentation

Issues Flagged

1. Minor technical inaccuracy — “encrypted with a key pair”
In the payload logging paragraph, the parenthetical says (encrypted with a key pair that you provide). In asymmetric cryptography, data is encrypted with the public key from the pair, not the pair itself. The existing payload logging overview already uses the phrasing “encrypted with a customer-provided public key”.

Suggested change: Update the wording to match the existing documentation.

src/content/docs/waf/managed-rules/troubleshooting.mdx (line 25)

To get more detail about which part of a request matched a managed rule, enable [payload logging](/waf/managed-rules/payload-logging/) for the affected managed ruleset. Payload logging records the specific string that triggered each rule (encrypted with a public key that you provide), which helps you confirm whether a match was a false positive. If you have not set it up yet, [configure payload logging](/waf/managed-rules/payload-logging/configure/) so that the matched payload is available the next time you investigate a false positive. Payload logging is available on Enterprise plans.

2. (Optional) Plan restriction formatting
The Enterprise plan requirement is stated inline: Payload logging is available on Enterprise plans. The style guide recommends using a :::note admonition for plan restrictions when they cannot be integrated into prose. Since it is integrated here, inline text is acceptable, but wrapping it in a note admonition would make it more prominent. This is optional and can be left to author/maintainer discretion.

3. (Optional) Link text for configuration page
The link text configure payload logging is a descriptive verb phrase. While this reads naturally, the style guide prefers link text that matches the target page title (Configure payload logging in the dashboard). Existing WAF docs do use both styles, so this is non-blocking.


Verdict: LGTM with the suggested wording fix for the encryption description. All links verified, frontmatter unchanged, and no build concerns identified.

github run

@zeinjaber zeinjaber marked this pull request as ready for review June 25, 2026 08:39
@zeinjaber zeinjaber requested review from a team, danielegm, elithrar and hsaxenaCF as code owners June 25, 2026 08:39
@zeinjaber zeinjaber enabled auto-merge (squash) June 25, 2026 08:39
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jun 25, 2026

Copy link
Copy Markdown
Contributor

Review

✅ No issues found in commit 5d42d8f.

Code Review

This code review is in beta and may not always be helpful — use your judgment.

✅ No code review issues found.

Style Guide Review

✅ No style-guide issues found.

Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.
/ignore-review-limit Permanently lifts the 2-review automatic limit for this PR. Future pushes will trigger reviews as normal.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants