Adds user-definable log formatting by SonicZentropy · Pull Request #3778 · bevyengine/bevy

SonicZentropy · 2022-01-27T02:28:13Z

Objective

Allow users to alter log formatting

Solution

tracing_subscriber offers a Subscriber trait to allow this customization, so I put one into LogSettings and check for it before making the prior default Subscriber.

SonicZentropy · 2022-01-28T04:37:00Z

Post-CI I'm not sure this is even worth draft status at the moment. It seems wasm and android builds both add required trait bounds on anything holding a Subscriber that enter the HRTB territory, which is fascinating but pretty beyond me at this point and perhaps better left to collect cobwebs until I understand what's going on better

SonicZentropy · 2022-01-29T00:02:47Z

Nevermind, found a better way, seems to work fine now!

rparrett · 2022-01-29T14:12:49Z

I wonder how this potentially interacts with the trace_chrome and trace_tracy features, and if it makes sense to use a separate subscriber for logging and tracing.

Could be a bit of a footgun if defining a custom logging format prevents you from profiling your code in the future. I'm not really familiar enough with tracing to say.

I just want to point out another PR that touches this code here: #3583.

SonicZentropy · 2022-01-29T16:47:50Z

You actually were completely correct about that @rparrett, though I didn't see this until I just stumbled across it in use. I stuck my head into tokio's Discord and had them help me modify it to a more proper version. This one should take care of those issues

Link to Tokio discussion regarding this

mockersf · 2022-02-04T20:09:43Z

crates/bevy_log/src/lib.rs

 /// # use bevy_app::App;
 /// # use bevy_log::LogSettings;
-/// # use bevy_utils::tracing::Level;
+/// # use bevy_utils::tracing::{ Level };


this looks like something that was part of an experiment and you didn't revert back completely?

Yes, sorry about the delay, honestly forgot this PR existed after a while. That was probably my global config clashing and me not noticing, sorry

SonicZentropy · 2022-03-23T03:26:23Z

I missed the super basic formatting problem and this didn't get merged, apologies. Looks like it has a conflict now, so I'll try to resolve it this weekend since I'm sure it'll be minor

alice-i-cecile · 2022-05-02T12:19:55Z

crates/bevy_log/src/lib.rs

 /// # use bevy_app::App;
 /// # use bevy_log::LogSettings;
-/// # use bevy_utils::tracing::Level;
+/// # use bevy_utils::tracing::{ Level };


Suggested change

/// # use bevy_utils::tracing::{ Level };

/// # use bevy_utils::tracing::Level;

alice-i-cecile · 2022-05-02T12:20:26Z

@SonicZentropy I'd like to merge this :) While you're rebasing, there's a tiny formatting suggestion for the doc example too.

vladbat00 · 2022-05-13T10:50:09Z

It would be great if we allowed our users to pass not just 1 layer but multiple ones. Or we maybe could allow passing a custom subscriber, like it was done in the initial attempt, I'm curious what was the problem exactly with that one.
This way users can also get the benefit of not only customizing the formatter but also passing additional layers - that would come in handy for the puffin integration for instance if we decide that it should exist outside of Bevy and be added by users via either a plugin or by passing a puffin layer manually.

@SonicZentropy

# Objective Adopted bevyengine#3778. This pr allows to configure how the bevy log is formatted. The default bevy log can be a bit verbose for some projects, specially the timestamp. The objective is to allow developers to select the format that best suits them. ``` Example of original bevy log: 2023-04-13T14:19:53.674653Z INFO bevy_render::renderer: [important text!] ``` ## Solution Using `tracing_subscriber::fmt::Subscriber`, adds the attribute `layer` to `LogPlugin`. This allows to pass a `tracing_subscriber::fmt::Layer` when creating the plugin and modifying the output. For example this ```rust App::new() .add_plugins(DefaultPlugins.set(bevy::log::LogPlugin { layer: Box::new(|| Box::new(bevy::log::tracing_subscriber::fmt::layer().pretty().without_time())) ..default() })) .run() ``` prints ``` INFO bevy_render::renderer: [important text!] ``` The main idea comes from @SonicZentropy and their pull request bevyengine#3778, but it was stale since may. This has all the changes and a fix since now `LogSettings` are included in the plugin and not in a resource. Since plugin builders are stateless and not mutable (bevyengine#8101), the old solution of using an `Option<Box<Layer>>` no longer works. One solution to fix this is to use a `Box<Fn() -> Box<Layer>>`. I am unaware of another more idiomatic fix, so if you have something better please revise it. Should plugins builders be mutable in the future, this can be changed back to the original approach. --- ## Changelog - Adds field `layer` to `LogPlugin` that takes a function returning a `tracing_subscriber` custom layer. - Reexports `tracing_subscriber` from log so it can be used to configure the plugin. - Modifies the `logs.rs` and `system_piping.rs` examples to include the new configuration. ## Migration Guide No breaking changes

@SonicZentropy

# Objective Adopted bevyengine#3778. This pr allows to configure how the bevy log is formatted. The default bevy log can be a bit verbose for some projects, specially the timestamp. The objective is to allow developers to select the format that best suits them. ``` Example of original bevy log: 2023-04-13T14:19:53.674653Z INFO bevy_render::renderer: [important text!] ``` ## Solution Using `tracing_subscriber::fmt::Subscriber`, adds the attribute `layer` to `LogPlugin`. This allows to pass a `tracing_subscriber::fmt::Layer` when creating the plugin and modifying the output. For example this ```rust App::new() .add_plugins(DefaultPlugins.set(bevy::log::LogPlugin { layer: Box::new(|| Box::new(bevy::log::tracing_subscriber::fmt::layer().pretty().without_time())) ..default() })) .run() ``` prints ``` INFO bevy_render::renderer: [important text!] ``` The main idea comes from @SonicZentropy and their pull request bevyengine#3778, but it was stale since may. This has all the changes and a fix since now `LogSettings` are included in the plugin and not in a resource. Since plugin builders are stateless and not mutable (bevyengine#8101), the old solution of using an `Option<Box<Layer>>` no longer works. One solution to fix this is to use a `Box<Fn() -> Box<Layer>>`. I am unaware of another more idiomatic fix, so if you have something better please revise it. Should plugins builders be mutable in the future, this can be changed back to the original approach. --- ## Changelog - Adds field `layer` to `LogPlugin` that takes a function returning a `tracing_subscriber` custom layer. - Reexports `tracing_subscriber` from log so it can be used to configure the plugin. - Modifies the `logs.rs` and `system_piping.rs` examples to include the new configuration. ## Migration Guide No breaking changes

tygyh · 2024-01-28T17:33:36Z

I believe the functionality from this PR has already been added in other later changes. Is there a reason to keep it open?

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

alice-i-cecile added C-Usability A targeted quality-of-life change that makes Bevy easier to use A-Log and removed S-Needs-Triage This issue needs to be labelled labels Jan 27, 2022

SonicZentropy marked this pull request as draft January 27, 2022 10:35

Adds user-definable log formatting

7ac052e

SonicZentropy force-pushed the main branch 2 times, most recently from 366d467 to d8c205b Compare January 28, 2022 23:35

Switched to Layer rather than Subscriber to quiet trait bounds nightmare

6bdf5a2

SonicZentropy force-pushed the main branch from d8c205b to 6bdf5a2 Compare January 28, 2022 23:39

SonicZentropy marked this pull request as ready for review January 29, 2022 00:02

Fixes default layer from silently eating logs

366eb44

SonicZentropy force-pushed the main branch from 51d368a to 366eb44 Compare January 29, 2022 16:45

IceSentry approved these changes Jan 29, 2022

View reviewed changes

alice-i-cecile approved these changes Feb 4, 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 4, 2022

mockersf reviewed Feb 4, 2022

View reviewed changes

alice-i-cecile reviewed May 2, 2022

View reviewed changes

alice-i-cecile added the S-Adopt-Me The original PR author has no intent to complete this work. Pick me up! label May 9, 2022

cart added A-Diagnostics Logging, crash handling, error reporting and performance analysis and removed A-Log labels Jun 1, 2022

eerii mentioned this pull request Apr 13, 2023

Support for user defined log formatting #8374

Closed

alice-i-cecile closed this Jan 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Adds user-definable log formatting#3778

Adds user-definable log formatting#3778
SonicZentropy wants to merge 3 commits intobevyengine:mainfrom
SonicZentropy:main

SonicZentropy commented Jan 27, 2022

Uh oh!

SonicZentropy commented Jan 28, 2022

Uh oh!

SonicZentropy commented Jan 29, 2022

Uh oh!

rparrett commented Jan 29, 2022 •

edited

Loading

Uh oh!

SonicZentropy commented Jan 29, 2022 •

edited

Loading

Uh oh!

mockersf Feb 4, 2022

Uh oh!

SonicZentropy Mar 23, 2022

Uh oh!

SonicZentropy commented Mar 23, 2022

Uh oh!

alice-i-cecile May 2, 2022

Uh oh!

alice-i-cecile commented May 2, 2022

Uh oh!

vladbat00 commented May 13, 2022

Uh oh!

tygyh commented Jan 28, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

	/// # use bevy_utils::tracing::{ Level };
	/// # use bevy_utils::tracing::Level;

Uh oh!

Conversation

SonicZentropy commented Jan 27, 2022

Objective

Solution

Uh oh!

SonicZentropy commented Jan 28, 2022

Uh oh!

SonicZentropy commented Jan 29, 2022

Uh oh!

rparrett commented Jan 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

SonicZentropy commented Jan 29, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mockersf Feb 4, 2022

Choose a reason for hiding this comment

Uh oh!

SonicZentropy Mar 23, 2022

Choose a reason for hiding this comment

Uh oh!

SonicZentropy commented Mar 23, 2022

Uh oh!

alice-i-cecile May 2, 2022

Choose a reason for hiding this comment

Uh oh!

alice-i-cecile commented May 2, 2022

Uh oh!

vladbat00 commented May 13, 2022

Uh oh!

tygyh commented Jan 28, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

rparrett commented Jan 29, 2022 •

edited

Loading

SonicZentropy commented Jan 29, 2022 •

edited

Loading