[stub] Write docs/playbook on how to debug Pinniped
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 739
- Forks
- 85
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 1
Description
Sometimes stuff breaks. It would nice to have docs that we could point folks to in regards to collecting logs as well as understanding what the logs mean. As we collect common failure modes, we could include those in the docs (assuming we cannot fix them through code). We would want to make sure that we warn folks about leaving logs set to high level for both performance and security reasons.
Contributor guide
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
No documentation file or test is named in the issue. Start by locating existing debugging, logging, and troubleshooting documentation in the repository, then define the playbook around log collection, log interpretation, common failure modes, and performance and security warnings; done means these topics are documented for users.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- kubernetes
- Domain
- documentation, observability-sre
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100