NAP WAF: Missing Brute Force log variables in docs

Open Beginner friendly
#486 10 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
76/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
nginx
Domain
documentation

Research direction

Open content/nap-waf/v4/logging-overview/security-log.md and content/nap-waf/v5/logging-overview/security-log.md, then review their Available Security Log Attributes sections. Add the $username and $login_result variables with their descriptions to both pages; done means the Brute Force log variables are documented consistently in v4 and v5.

Written by the indexing model from the issue text.

Description

bug P2 - Important (TTR: 2 weeks)
Describe the bug

When the Brute Force feature was released in NAP WAF 4.13, some log variables essential to this feature were missed from the documentation.

In summary, the $username and $login_result variables (and their descriptions) are missing from the Available Security Log Attributes section on the v4 security log and v5 security log pages.

To reproduce

N/A

Expected behavior

A clear and concise description of what you expected to happen.

Your environment
  • Version/release of this project or specific commit
  • Target deployment platform
Additional context

Add any other context about the problem here.

Sensitive Information

Remember to redact any sensitive information such as authentication credentials or license keys.

Dominant language
HTML
Stars
94
Forks
174
Avg merge
1d 10h
Merged PRs (30d)
66

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from nginx/documentation

All issues in nginx/documentation

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.