Add some tracing to core bootstrap logic #136091

jieyouxu · 2025-01-26T10:31:12Z

Follow-up to #135391.

Summary

Add some initial tracing logging to bootstrap, focused on the core logic (in this PR).

Also:

Adjusted tracing-tree style to not use indent lines (I found that more distracting than helpful).
Avoid glob-importing tracing items.
Improve the rustc-dev-guide docs on bootstrap tracing.

Example output

$ BOOTSTRAP_TRACING=bootstrap=TRACE ./x check src/bootstrap

r? bootstrap

rustbot · 2025-01-26T10:31:21Z

The rustc-dev-guide subtree was changed. If this PR only touches the dev guide consider submitting a PR directly to rust-lang/rustc-dev-guide otherwise thank you for updating the dev guide with your changes.

cc @BoxyUwU, @jieyouxu, @Kobzol

This PR modifies src/bootstrap/src/core/config.

If appropriate, please update CONFIG_CHANGE_HISTORY in src/bootstrap/src/utils/change_tracker.rs.

src/bootstrap/src/core/config/config.rs

clubby789 · 2025-01-26T14:30:31Z

Looks like helpful improvements, r=me with nit

jieyouxu · 2025-01-26T17:28:00Z

Removed the extra comma
@bors r=@clubby789 rollup

bors · 2025-01-26T17:28:03Z

📌 Commit 97efda6 has been approved by clubby789

It is now in the queue for this repository.

Add some tracing to core bootstrap logic Follow-up to rust-lang#135391. ### Summary Add some initial tracing logging to bootstrap, focused on the core logic (in this PR). Also: - Adjusted tracing-tree style to not use indent lines (I found that more distracting than helpful). - Avoid glob-importing `tracing` items. - Improve the rustc-dev-guide docs on bootstrap tracing. ### Example output ```bash $ BOOTSTRAP_TRACING=bootstrap=TRACE ./x check src/bootstrap ``` ![Example bootstrap tracing output](https://github.com/user-attachments/assets/0be39042-0822-44b6-9451-30427cfea156) r? bootstrap

Rollup of 5 pull requests Successful merges: - rust-lang#135807 (Implement phantom variance markers) - rust-lang#136091 (Add some tracing to core bootstrap logic) - rust-lang#136094 (Upgrade elsa to the newest version.) - rust-lang#136097 (rustc_ast: replace some len-checks + indexing with slice patterns etc.) - rust-lang#136101 (triagebot: set myself on vacation) r? `@ghost` `@rustbot` modify labels: rollup

Rollup of 8 pull requests Successful merges: - rust-lang#126604 (Uplift `clippy::double_neg` lint as `double_negations`) - rust-lang#135158 (Add `TooGeneric` variant to `LayoutError` and emit `Unknown`) - rust-lang#135635 (Move `std::io::pipe` code into its own file) - rust-lang#136072 (add two old crash tests) - rust-lang#136079 (compiler_fence: fix example) - rust-lang#136091 (Add some tracing to core bootstrap logic) - rust-lang#136097 (rustc_ast: replace some len-checks + indexing with slice patterns etc.) - rust-lang#136101 (triagebot: set myself on vacation) r? `@ghost` `@rustbot` modify labels: rollup

onur-ozkan · 2025-01-27T09:33:18Z

src/bootstrap/src/bin/main.rs

+    #[cfg(feature = "tracing")]
+    debug!("parsing flags");


I would simplify this by creating a logging wrapper macro (tracing_debug?) gated from tracing feature, which doesn't do anything on #[cfg(not(feature = "tracing")]) and uses debug macro on #[cfg(feature = "tracing")], so you don't need to add this conditional checks everywhere.

Good point, I forgor you could just forward via $($tokens:tt)*. I'll send a follow-up.

Follow-up: #136392

Rollup merge of rust-lang#136091 - jieyouxu:core-tracing, r=clubby789 Add some tracing to core bootstrap logic Follow-up to rust-lang#135391. ### Summary Add some initial tracing logging to bootstrap, focused on the core logic (in this PR). Also: - Adjusted tracing-tree style to not use indent lines (I found that more distracting than helpful). - Avoid glob-importing `tracing` items. - Improve the rustc-dev-guide docs on bootstrap tracing. ### Example output ```bash $ BOOTSTRAP_TRACING=bootstrap=TRACE ./x check src/bootstrap ``` ![Example bootstrap tracing output](https://github.com/user-attachments/assets/0be39042-0822-44b6-9451-30427cfea156) r? bootstrap

fmease · 2025-02-02T02:04:43Z

@bors r- ('fixing' desync)

bootstrap: add wrapper macros for `feature = "tracing"`-gated `tracing` macros Follow-up to rust-lang#136091 (comment). - Add wrapper macros for `error!`, `warn!`, `info!`, `debug!` and `trace!`, which `cfg(feature = "tracing")`-gates the underlying `tracing` macros. They expand to nothing if `"tracing"` feature is not enabled. - This is not done for `span!` or `event!` because they can return span guards, and you can't really wrap that. - This is also not possible for `tracing::instrument` attribute proc-macro unless you use another attribute proc-macro to wrap that. It's not *great*, because `tracing::instrument` and `tracing::{span,event}` can't be wrapped this way. Can test locally with: ```bash $ BOOTSTRAP_TRACING=bootstrap=TRACE ./x check src/bootstrap/ ``` r? `@onur-ozkan` (or reroll)

bootstrap: add wrapper macros for `feature = "tracing"`-gated `tracing` macros Follow-up to rust-lang#136091 (comment). - Add wrapper macros for `error!`, `warn!`, `info!`, `debug!` and `trace!`, which `cfg(feature = "tracing")`-gates the underlying `tracing` macros. They expand to nothing if `"tracing"` feature is not enabled. - This is not done for `span!` or `event!` because they can return span guards, and you can't really wrap that. - This is also not possible for `tracing::instrument` attribute proc-macro unless you use another attribute proc-macro to wrap that. It's not *great*, because `tracing::instrument` and `tracing::{span,event}` can't be wrapped this way. Can test locally with: ```bash $ BOOTSTRAP_TRACING=bootstrap=TRACE ./x check src/bootstrap/ ``` r? ``@onur-ozkan`` (or reroll)

bootstrap: add wrapper macros for `feature = "tracing"`-gated `tracing` macros Follow-up to rust-lang#136091 (comment). - Add wrapper macros for `error!`, `warn!`, `info!`, `debug!` and `trace!`, which `cfg(feature = "tracing")`-gates the underlying `tracing` macros. They expand to nothing if `"tracing"` feature is not enabled. - This is not done for `span!` or `event!` because they can return span guards, and you can't really wrap that. - This is also not possible for `tracing::instrument` attribute proc-macro unless you use another attribute proc-macro to wrap that. It's not *great*, because `tracing::instrument` and `tracing::{span,event}` can't be wrapped this way. Can test locally with: ```bash $ BOOTSTRAP_TRACING=bootstrap=TRACE ./x check src/bootstrap/ ``` r? ```@onur-ozkan``` (or reroll)

bootstrap: add wrapper macros for `feature = "tracing"`-gated `tracing` macros Follow-up to rust-lang#136091 (comment). - Add wrapper macros for `error!`, `warn!`, `info!`, `debug!` and `trace!`, which `cfg(feature = "tracing")`-gates the underlying `tracing` macros. They expand to nothing if `"tracing"` feature is not enabled. - This is not done for `span!` or `event!` because they can return span guards, and you can't really wrap that. - This is also not possible for `tracing::instrument` attribute proc-macro unless you use another attribute proc-macro to wrap that. It's not *great*, because `tracing::instrument` and `tracing::{span,event}` can't be wrapped this way. Can test locally with: ```bash $ BOOTSTRAP_TRACING=bootstrap=TRACE ./x check src/bootstrap/ ``` r? ````@onur-ozkan```` (or reroll)

bootstrap: add wrapper macros for `feature = "tracing"`-gated `tracing` macros Follow-up to rust-lang#136091 (comment). - Add wrapper macros for `error!`, `warn!`, `info!`, `debug!` and `trace!`, which `cfg(feature = "tracing")`-gates the underlying `tracing` macros. They expand to nothing if `"tracing"` feature is not enabled. - This is not done for `span!` or `event!` because they can return span guards, and you can't really wrap that. - This is also not possible for `tracing::instrument` attribute proc-macro unless you use another attribute proc-macro to wrap that. It's not *great*, because `tracing::instrument` and `tracing::{span,event}` can't be wrapped this way. Can test locally with: ```bash $ BOOTSTRAP_TRACING=bootstrap=TRACE ./x check src/bootstrap/ ``` r? `@onur-ozkan` (or reroll)

bootstrap: add wrapper macros for `feature = "tracing"`-gated `tracing` macros Follow-up to rust-lang#136091 (comment). - Add wrapper macros for `error!`, `warn!`, `info!`, `debug!` and `trace!`, which `cfg(feature = "tracing")`-gates the underlying `tracing` macros. They expand to nothing if `"tracing"` feature is not enabled. - This is not done for `span!` or `event!` because they can return span guards, and you can't really wrap that. - This is also not possible for `tracing::instrument` attribute proc-macro unless you use another attribute proc-macro to wrap that. It's not *great*, because `tracing::instrument` and `tracing::{span,event}` can't be wrapped this way. Can test locally with: ```bash $ BOOTSTRAP_TRACING=bootstrap=TRACE ./x check src/bootstrap/ ``` r? ``@onur-ozkan`` (or reroll)

Rollup merge of rust-lang#136392 - jieyouxu:wrap-tracing, r=onur-ozkan bootstrap: add wrapper macros for `feature = "tracing"`-gated `tracing` macros Follow-up to rust-lang#136091 (comment). - Add wrapper macros for `error!`, `warn!`, `info!`, `debug!` and `trace!`, which `cfg(feature = "tracing")`-gates the underlying `tracing` macros. They expand to nothing if `"tracing"` feature is not enabled. - This is not done for `span!` or `event!` because they can return span guards, and you can't really wrap that. - This is also not possible for `tracing::instrument` attribute proc-macro unless you use another attribute proc-macro to wrap that. It's not *great*, because `tracing::instrument` and `tracing::{span,event}` can't be wrapped this way. Can test locally with: ```bash $ BOOTSTRAP_TRACING=bootstrap=TRACE ./x check src/bootstrap/ ``` r? ``@onur-ozkan`` (or reroll)

bootstrap: add wrapper macros for `feature = "tracing"`-gated `tracing` macros Follow-up to rust-lang/rust#136091 (comment). - Add wrapper macros for `error!`, `warn!`, `info!`, `debug!` and `trace!`, which `cfg(feature = "tracing")`-gates the underlying `tracing` macros. They expand to nothing if `"tracing"` feature is not enabled. - This is not done for `span!` or `event!` because they can return span guards, and you can't really wrap that. - This is also not possible for `tracing::instrument` attribute proc-macro unless you use another attribute proc-macro to wrap that. It's not *great*, because `tracing::instrument` and `tracing::{span,event}` can't be wrapped this way. Can test locally with: ```bash $ BOOTSTRAP_TRACING=bootstrap=TRACE ./x check src/bootstrap/ ``` r? ``@onur-ozkan`` (or reroll)

rustbot assigned clubby789 Jan 26, 2025

rustbot added A-rustc-dev-guide Area: rustc-dev-guide S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-bootstrap Relevant to the bootstrap subteam: Rust's build system (x.py and src/bootstrap) labels Jan 26, 2025

jieyouxu added the A-bootstrap-tracing Area: bootstrap tracing label Jan 26, 2025

clubby789 reviewed Jan 26, 2025

View reviewed changes

src/bootstrap/src/core/config/config.rs Outdated Show resolved Hide resolved

jieyouxu added 5 commits January 27, 2025 01:24

bootstrap: avoid glob imports in main binary

4febbd5

bootstrap: adjust tracing style

761bda1

bootstrap: adjust config file cascading fallback comment

71703bb

bootstrap: add more logging

2e1a532

rustc-dev-guide: update bootstrap tracing docs

97efda6

jieyouxu force-pushed the core-tracing branch from cea05f9 to 97efda6 Compare January 26, 2025 17:27

bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jan 26, 2025

jhpratt mentioned this pull request Jan 27, 2025

Rollup of 5 pull requests #136111

Closed

fmease mentioned this pull request Jan 27, 2025

Rollup of 8 pull requests #136116

Merged

onur-ozkan reviewed Jan 27, 2025

View reviewed changes

bors merged commit e72e49a into rust-lang:master Jan 27, 2025
6 checks passed

rustbot added this to the 1.86.0 milestone Jan 27, 2025

jieyouxu deleted the core-tracing branch January 27, 2025 11:26

jieyouxu mentioned this pull request Feb 1, 2025

bootstrap: add wrapper macros for feature = "tracing"-gated tracing macros #136392

Merged

bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Feb 2, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add some tracing to core bootstrap logic #136091

Add some tracing to core bootstrap logic #136091

jieyouxu commented Jan 26, 2025 •

edited

Loading

rustbot commented Jan 26, 2025

clubby789 commented Jan 26, 2025

jieyouxu commented Jan 26, 2025

bors commented Jan 26, 2025

onur-ozkan Jan 27, 2025

jieyouxu Jan 27, 2025

jieyouxu Feb 1, 2025

fmease commented Feb 2, 2025

Add some tracing to core bootstrap logic #136091

Add some tracing to core bootstrap logic #136091

Conversation

jieyouxu commented Jan 26, 2025 • edited Loading

Summary

Example output

rustbot commented Jan 26, 2025

clubby789 commented Jan 26, 2025

jieyouxu commented Jan 26, 2025

bors commented Jan 26, 2025

onur-ozkan Jan 27, 2025

Choose a reason for hiding this comment

jieyouxu Jan 27, 2025

Choose a reason for hiding this comment

jieyouxu Feb 1, 2025

Choose a reason for hiding this comment

fmease commented Feb 2, 2025

jieyouxu commented Jan 26, 2025 •

edited

Loading