[Feature request]: Introspection and debugging API
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 25/100
Research direction
The issue names no files, tests, or entry points to begin with. First clarify which checked capabilities are in scope and how the API should operate outside a Bevy-managed thread, including optional performance-impacting hooks. Done requires an agreed API scope and design for introspection, breakpoints, and resuming before implementation can be estimated.
Written by the indexing model from the issue text.
Description
Before proceeding, is there an existing issue or discussion for this?
- I have done a search for similar issues and discussions.
Description
It would be good if there is a introspection and debugging API to allow
- Querying the list of currently running nodes
- Query the amount of times a node is activated and the time it took for it to produce an output
- Setting a breakpoint to pause execution when a node is activated
- Query the source or reason the node is activated
- Resuming a paused node
- Forcing a node to produce a given output
- Forcing a node to receive a given input
- Change the buffers and streams used by a node
Implementation Considerations
The API should be accessible from outside the workflow, i.e. from a non bevy managed thread. If the API requires any hooks that might impact performance, it should be made optional.
Alternatives
Detailed logging and tracing for when a node is activated, how long it took, reason for activation etc.
Additional information
No response
- Dominant language
- Rust
- Stars
- 75
- Forks
- 18
- Avg merge
- 12d 12h
- Merged PRs (30d)
- 3
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing 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.
More from open-rmf/crossflow
-
Diagram editor fails to build on Windows: build.rs can't find pnpm (pnpm.cmd)Possibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 4/5 3-5 days Newbie friendliness 52/100
-
Difficulty 3/5 1-2 days Newbie friendliness 55/100
-
Difficulty 4/5 3-5 days Newbie friendliness 45/100
-
Difficulty 5/5 Over a week Newbie friendliness 45/100
All issues in open-rmf/crossflow
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
storytold/photocraft#14822 ·
Maintainers usually reply within 1 day
-
bug css
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
dginev/latexml-oxide#853 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 2 days
-
[Bug] export_build_environment admits its output directory only after the export ran in the build computerPossibly taken @viniciusdsandrade claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day