open-rmf / open-rmf/crossflow

[Feature request]: Introspection and debugging API

Open
#86 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Rust
Stars
72
Forks
16
PR merge metrics
No merged PRs in 30d

Description

Before proceeding, is there an existing issue or discussion for this?
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

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

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.

Assessment

Tech stack
rust
Domain
devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.