MagicStack / MagicStack/uvloop
Implement tracing support
Nobody has claimed this yet.
- Dominant language
- Cython
- Stars
- 11.9k
- Forks
- 616
- PR merge metrics
- No merged PRs in 30d
Description
This is a meta issue to discuss how new asyncio tracing API should look like. We will implement it first in uvloop, and later, if necessary, port it to asyncio.
Requirements
-
Base on the new
contextvars(PEP 567) API, so that async tasks and callbacks they schedule are traced consistently. -
Traces should be hierarchical, i.e. it should be possible to see what and how exactly one Task did, what Tasks that it spawned did, etc.
-
Low performance overhead. Ideally we should be able to run tracing in production.
-
Low-level and detailed: we want to be able to measure DNS requests, read/write callbacks performance, throughput, number of callbacks/tasks created etc.
-
Flexibility: traces should be in easy to work with format, so that it's possible to submit them to existing systems like zipkin.
-
Extensibility: the new API should be easy to maintain on both ends: in the event loop and in applications that use it. This means that adding a new kind of trace should not require people to write any glue code.
-
[TBD]
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 reviewing this issue's requirements and the PEP 567 contextvars API; no implementation files, tests, or entry points are named. Done would mean reaching agreement on a hierarchical, low-overhead, detailed, flexible, and extensible asyncio tracing API before implementation begins.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- backend, networking
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100