linux-credentials / linux-credentials/libwebauthn
Standardise log levels
Open
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 579
- Forks
- 27
- Avg merge
- 4d 6h
- Merged PRs (30d)
- 1
Description
Analyse the codebase for use of logging, write a policy.
Starting point:
warn!for unexpected device behaviourerror!for library errors onlytrace!for verbose bytearray dumps,debug!only lenghts or very small, relevant fields- Sensitive request/response content at
debug!or more verbose only debug!({ %foo, ?bar }, "Static comment")anderror!(?err, "Error message")over string interpolation
Bonus point for automated linting checks.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by searching the Rust codebase for logging calls and compare them with the proposed warn!, error!, trace!, and debug! policy. Document the agreed logging rules, update inconsistent uses, and check that sensitive request/response content and structured fields follow the stated guidance. Done means the policy is written and the codebase conforms; automated linting is an optional bonus.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- observability-sre
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100