Skip to content

Commit

Permalink
[Debugger] Clarify that only one paused task can be debugged at a time (
Browse files Browse the repository at this point in the history
ray-project#48415)

<!-- Thank you for your contribution! Please review
https://github.com/ray-project/ray/blob/master/CONTRIBUTING.rst before
opening a pull request. -->

<!-- Please add a reviewer to the assignee section when you create a PR.
If you don't have the access to it, we will shortly find a reviewer and
assign them to your PR. -->

## Why are these changes needed?

I was initially confused that I couldn't join another paused task while
a debugger was in "continue" mode.

## Related issue number

<!-- For example: "Closes ray-project#1234" -->

## Checks

- [ ] I've signed off every commit(by using the -s flag, i.e., `git
commit -s`) in this PR.
- [ ] I've run `scripts/format.sh` to lint the changes in this PR.
- [ ] I've included any doc changes needed for
https://docs.ray.io/en/master/.
- [ ] I've added any new APIs to the API Reference. For example, if I
added a
method in Tune, I've added it in `doc/source/tune/api/` under the
           corresponding `.rst` file.
- [ ] I've made sure the tests are passing. Note that there might be a
few flaky tests, see the recent failures at https://flakey-tests.ray.io/
- Testing Strategy
   - [ ] Unit tests
   - [ ] Release tests
   - [ ] This PR is not tested :(

---------

Signed-off-by: Philipp Moritz <[email protected]>
Co-authored-by: bhuang <[email protected]>
Co-authored-by: angelinalg <[email protected]>
  • Loading branch information
3 people authored Oct 30, 2024
1 parent 66265ab commit 1e5c582
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 7 additions & 3 deletions doc/source/ray-observability/ray-distributed-debugger.rst
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,14 @@ When the debugger hits a breakpoint:
:align: center


Start debugging
~~~~~~~~~~~~~~~
Start and stop debugging
~~~~~~~~~~~~~~~~~~~~~~~~

Debug your Ray app as you would when developing locally.
Debug your Ray app as you would when developing locally. After you're done debugging this particular
breakpoint, click the **Disconnect** button in the debugging toolbar so you can join another task
in the **Paused Tasks** list.

.. figure:: ./images/debugger-disconnect.gif


Post-mortem debugging
Expand Down

0 comments on commit 1e5c582

Please sign in to comment.