Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

allow getting task dump backtraces in a programmatic format #6975

Merged
merged 10 commits into from
Dec 9, 2024

Conversation

arielb1
Copy link
Contributor

@arielb1 arielb1 commented Nov 14, 2024

This PR creates structs that allow dumping backtraces in a programmatic format, for example JSON. A JSON serializer is not natively included to avoid creating a Tokio dependency on one, but serialization can be done by customers.

Fixes #6309.

@github-actions github-actions bot added R-loom-current-thread Run loom current-thread tests on this PR R-loom-multi-thread Run loom multi-thread tests on this PR R-loom-multi-thread-alt Run loom multi-thread alt tests on this PR labels Nov 14, 2024
@arielb1 arielb1 force-pushed the programmatic-backtraces branch 3 times, most recently from df04fc7 to ede6e06 Compare November 14, 2024 18:00
@arielb1
Copy link
Contributor Author

arielb1 commented Nov 19, 2024

What is this waiting for?

@arielb1
Copy link
Contributor Author

arielb1 commented Nov 20, 2024

So @Darksonn is busy these days. Could @mox692 please review this?

@Darksonn Darksonn added A-tokio Area: The main tokio crate M-taskdump --cfg tokio_taskdump labels Nov 21, 2024
Copy link
Member

@mox692 mox692 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you! I left high level questions about suggested apis.

tokio/src/runtime/dump.rs Show resolved Hide resolved
tokio/src/runtime/dump.rs Outdated Show resolved Hide resolved
tokio/src/runtime/dump.rs Outdated Show resolved Hide resolved
@arielb1 arielb1 force-pushed the programmatic-backtraces branch 4 times, most recently from d96b28a to 3f9d94f Compare November 25, 2024 13:44
tokio/src/runtime/dump.rs Outdated Show resolved Hide resolved
tokio/src/runtime/dump.rs Outdated Show resolved Hide resolved
tokio/src/runtime/dump.rs Outdated Show resolved Hide resolved
@arielb1 arielb1 force-pushed the programmatic-backtraces branch from 3f9d94f to 0ab0985 Compare November 30, 2024 16:57
@arielb1 arielb1 force-pushed the programmatic-backtraces branch from 0ab0985 to 7aaf2e7 Compare November 30, 2024 16:57
@arielb1
Copy link
Contributor Author

arielb1 commented Nov 30, 2024

addressed comments

@Darksonn Darksonn requested a review from mox692 December 4, 2024 09:27
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks fine. Just two things:

tokio/src/runtime/dump.rs Outdated Show resolved Hide resolved
tokio/src/runtime/dump.rs Outdated Show resolved Hide resolved
tokio/src/runtime/dump.rs Outdated Show resolved Hide resolved
tokio/src/runtime/dump.rs Outdated Show resolved Hide resolved
@arielb1 arielb1 force-pushed the programmatic-backtraces branch from 38717f9 to 6dc30e3 Compare December 4, 2024 15:42
tokio/src/runtime/dump.rs Outdated Show resolved Hide resolved
@arielb1 arielb1 force-pushed the programmatic-backtraces branch from de26d9b to b028387 Compare December 4, 2024 16:08
Copy link
Member

@mox692 mox692 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor doc related suggestions, but otherwise looks good to me.

tokio/src/runtime/dump.rs Outdated Show resolved Hide resolved
tokio/src/runtime/dump.rs Outdated Show resolved Hide resolved
tokio/src/runtime/dump.rs Outdated Show resolved Hide resolved
tokio/src/runtime/dump.rs Outdated Show resolved Hide resolved
@arielb1
Copy link
Contributor Author

arielb1 commented Dec 5, 2024

committed @mox692 doc suggestions. Can someone approve?

@arielb1 arielb1 force-pushed the programmatic-backtraces branch from ba09a06 to 295f0f6 Compare December 5, 2024 10:47
Co-authored-by: Motoyuki Kimura <moymoymox@gmail.com>
@arielb1 arielb1 force-pushed the programmatic-backtraces branch from 295f0f6 to f579f98 Compare December 5, 2024 11:02
Copy link
Member

@mox692 mox692 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

@arielb1
Copy link
Contributor Author

arielb1 commented Dec 6, 2024

Can you merge or are we waiting for @Darksonn ?

@mox692 mox692 merged commit 48e07a6 into tokio-rs:master Dec 9, 2024
87 checks passed
@mox692
Copy link
Member

mox692 commented Dec 9, 2024

Merged, thank you @arielb1.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio Area: The main tokio crate M-taskdump --cfg tokio_taskdump R-loom-current-thread Run loom current-thread tests on this PR R-loom-multi-thread Run loom multi-thread tests on this PR R-loom-multi-thread-alt Run loom multi-thread alt tests on this PR
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support an API to extract backtrace information from taskdump
3 participants