Write a guide for debugging tasks
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 598
- Forks
- 168
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 86
Description
Author: daviddavis (daviddavis)
Redmine Issue: 6537, https://pulp.plan.io/issues/6537
We've seen a few issues recently (eg [0]) about tasks getting stuck, etc. It would help to have a guide for developers and plugin writers on how to debug tasks.
A few topics:
- Using py-spy[1] to debug tasks
- Running asyncio in debug mode [2]
- Looking at coredumps of Pulp tasks
[0] https://pulp.plan.io/issues/6533
[1] https://github.com/benfred/py-spy
[2] https://docs.python.org/3/library/asyncio-dev.html#debug-mode
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
Review the listed py-spy and asyncio debug-mode references, then investigate how Pulp tasks expose or produce coredumps. Write a guide for developers and plugin writers covering the three requested debugging approaches, with enough context to make each usable for stuck tasks.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- devtools, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100