[Merged by Bors] - log spans on panic when trace is enabled #3848

mockersf · 2022-02-02T22:58:05Z

Objective

Help debug panics

Solution

Insert a custom panic hook when trace is enabled that will log spans

example when running a command on a despawned entity

before:

thread 'main' panicked at 'Could not add a component (of type `panic::Marker`) to entity 1v0 because it doesn't exist in this World.
If this command was added to a newly spawned entity, ensure that you have not despawned that entity within the same stage.
This may have occurred due to system order ambiguity, or if the spawning system has multiple command buffers', /bevy/crates/bevy_ecs/src/system/commands/mod.rs:664:13
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

after:

   0: bevy_ecs::schedule::stage::system_commands
           with name="panic::my_bad_system"
             at crates/bevy_ecs/src/schedule/stage.rs:871
   1: bevy_ecs::schedule::stage
           with name=Update
             at crates/bevy_ecs/src/schedule/mod.rs:340
   2: bevy_app::app::frame
             at crates/bevy_app/src/app.rs:111
   3: bevy_app::app::bevy_app
             at crates/bevy_app/src/app.rs:126
thread 'main' panicked at 'Could not add a component (of type `panic::Marker`) to entity 1v0 because it doesn't exist in this World.
If this command was added to a newly spawned entity, ensure that you have not despawned that entity within the same stage.
This may have occurred due to system order ambiguity, or if the spawning system has multiple command buffers', /bevy/crates/bevy_ecs/src/system/commands/mod.rs:664:13
note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

alice-i-cecile

Excellent! This helps a fair bit immediately, and should be a useful building block.

alice-i-cecile · 2022-02-02T23:32:10Z

IMO this is important / useful enough that I would like trace to be a default bevy feature. It doesn't appear to be, but our feature structure is rather elaborate.

cart · 2022-02-28T22:16:53Z

Lovely! Lots of value here.

IMO this is important / useful enough that I would like trace to be a default bevy feature. It doesn't appear to be, but our feature structure is rather elaborate.

trace adds a level of instrumentation that could register perf-wise in released apps. I'm not comfortable enabling it by default until we've shown that it doesn't meaningfully regress perf in any "real world" high-complexity apps.

cart · 2022-02-28T22:17:09Z

bors r+

# Objective - Help debug panics ## Solution - Insert a custom panic hook when trace is enabled that will log spans example when running a command on a despawned entity before: ``` thread 'main' panicked at 'Could not add a component (of type `panic::Marker`) to entity 1v0 because it doesn't exist in this World. If this command was added to a newly spawned entity, ensure that you have not despawned that entity within the same stage. This may have occurred due to system order ambiguity, or if the spawning system has multiple command buffers', /bevy/crates/bevy_ecs/src/system/commands/mod.rs:664:13 note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace ``` after: ``` 0: bevy_ecs::schedule::stage::system_commands with name="panic::my_bad_system" at crates/bevy_ecs/src/schedule/stage.rs:871 1: bevy_ecs::schedule::stage with name=Update at crates/bevy_ecs/src/schedule/mod.rs:340 2: bevy_app::app::frame at crates/bevy_app/src/app.rs:111 3: bevy_app::app::bevy_app at crates/bevy_app/src/app.rs:126 thread 'main' panicked at 'Could not add a component (of type `panic::Marker`) to entity 1v0 because it doesn't exist in this World. If this command was added to a newly spawned entity, ensure that you have not despawned that entity within the same stage. This may have occurred due to system order ambiguity, or if the spawning system has multiple command buffers', /bevy/crates/bevy_ecs/src/system/commands/mod.rs:664:13 note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace ```

superdump · 2022-02-28T22:54:16Z

Just want to say that I love this. :)

bors · 2022-02-28T22:55:09Z

Pull request successfully merged into main.

Build succeeded:

# Objective - Help debug panics ## Solution - Insert a custom panic hook when trace is enabled that will log spans example when running a command on a despawned entity before: ``` thread 'main' panicked at 'Could not add a component (of type `panic::Marker`) to entity 1v0 because it doesn't exist in this World. If this command was added to a newly spawned entity, ensure that you have not despawned that entity within the same stage. This may have occurred due to system order ambiguity, or if the spawning system has multiple command buffers', /bevy/crates/bevy_ecs/src/system/commands/mod.rs:664:13 note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace ``` after: ``` 0: bevy_ecs::schedule::stage::system_commands with name="panic::my_bad_system" at crates/bevy_ecs/src/schedule/stage.rs:871 1: bevy_ecs::schedule::stage with name=Update at crates/bevy_ecs/src/schedule/mod.rs:340 2: bevy_app::app::frame at crates/bevy_app/src/app.rs:111 3: bevy_app::app::bevy_app at crates/bevy_app/src/app.rs:126 thread 'main' panicked at 'Could not add a component (of type `panic::Marker`) to entity 1v0 because it doesn't exist in this World. If this command was added to a newly spawned entity, ensure that you have not despawned that entity within the same stage. This may have occurred due to system order ambiguity, or if the spawning system has multiple command buffers', /bevy/crates/bevy_ecs/src/system/commands/mod.rs:664:13 note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace ```

github-actions bot added the S-Needs-Triage This issue needs to be labelled label Feb 2, 2022

IceSentry added A-Log C-Usability A targeted quality-of-life change that makes Bevy easier to use and removed S-Needs-Triage This issue needs to be labelled labels Feb 2, 2022

insert a custom panic hook when trace is enabled

49af172

mockersf force-pushed the trace-panic branch from 64b8b4a to 49af172 Compare February 2, 2022 23:04

alice-i-cecile approved these changes Feb 2, 2022

View reviewed changes

mockersf mentioned this pull request Feb 3, 2022

EntityCommands should have methods to fail gracefully #3845

Closed

IceSentry approved these changes Feb 3, 2022

View reviewed changes

alice-i-cecile added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Feb 3, 2022

bors bot changed the title ~~log spans on panic when trace is enabled~~ [Merged by Bors] - log spans on panic when trace is enabled Feb 28, 2022

bors bot closed this Feb 28, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Merged by Bors] - log spans on panic when trace is enabled #3848

[Merged by Bors] - log spans on panic when trace is enabled #3848

mockersf commented Feb 2, 2022 •

edited

Loading

alice-i-cecile left a comment

alice-i-cecile commented Feb 2, 2022

cart commented Feb 28, 2022

cart commented Feb 28, 2022

superdump commented Feb 28, 2022

bors bot commented Feb 28, 2022

[Merged by Bors] - log spans on panic when trace is enabled #3848

[Merged by Bors] - log spans on panic when trace is enabled #3848

Conversation

mockersf commented Feb 2, 2022 • edited Loading

Objective

Solution

alice-i-cecile left a comment

Choose a reason for hiding this comment

alice-i-cecile commented Feb 2, 2022

cart commented Feb 28, 2022

cart commented Feb 28, 2022

superdump commented Feb 28, 2022

bors bot commented Feb 28, 2022

mockersf commented Feb 2, 2022 •

edited

Loading