feat(ci): lint debug fields in tracing events #664
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
14dc0c4 to
69d4d52
Compare
noot
reviewed
Jan 2, 2024
Comment on lines
+3
to
+11
| #[derive(Clone, Copy, Debug)] | ||
| struct Wrapped(&'static str); | ||
|
|
||
| fn main() { | ||
| let field = Wrapped("wrapped"); | ||
| info!(field = tracing::field::debug(field), "using the function"); | ||
| info!(field = ?field, "using the sigil"); | ||
| info!(?field, "using shorthand with sigil"); | ||
| } |
Contributor
There was a problem hiding this comment.
what is this for? just testing?
Contributor
Author
There was a problem hiding this comment.
Yeah, this ui/main.rs produces some output when compiled. https://github.com/Manishearth/compiletest-rs then tests the output against ui/main.stderr.
This is to make sure that all the cases that I want the lint to catch are caught.
noot
approved these changes
Jan 2, 2024
Contributor
noot
left a comment
There was a problem hiding this comment.
looks good! the if_chain is cool :D
…un on custom lints
3f36314 to
1054e81
Compare
joroshiba
approved these changes
Jan 3, 2024
SuperFluffy
added a commit
that referenced
this pull request
Jan 3, 2024
## Summary Build images using a Cargo.toml without a default-members entry. ## Background We use cargo-chef to prepare recipes for each individual binary so that only its dependencies are built and cached. PR #664 introduced the `default-members` entry so that cargo invocations by default don't target the lints (as they require a nightly compiler). But this breaks cargo-chef because it leaves default-members intact, leading to cargo compilation issues. ## Changes - Create a special `containerfiles/Cargo.toml` file that is derived from the root `Cargo.toml` but with its `default-members` entry removed - Update `containerfiles/Dockerfile` to run `cargo chef prepare` against `containerfiles/Cargo.toml` - Add a just entry to remove `workspace.default-members` from `Cargo.toml`, format it with `taplo`, and write it to `containerfiles/Cargo.toml` - Add a github job that ensures that `containerfiles/Cargo.toml` is in sync with `Cargo.toml` ## Testing - Docker builds were broken and now work again (verified by building locally and in CI) - Commited a modified `containerfiles/Cargo.toml` and observed the github action trigger ## Related Issues PR causing the build to break: #664
sgranfield4403-3
added a commit
to sgranfield4403-3/astria
that referenced
this pull request
Oct 2, 2025
## Summary Build images using a Cargo.toml without a default-members entry. ## Background We use cargo-chef to prepare recipes for each individual binary so that only its dependencies are built and cached. PR astriaorg/astria#664 introduced the `default-members` entry so that cargo invocations by default don't target the lints (as they require a nightly compiler). But this breaks cargo-chef because it leaves default-members intact, leading to cargo compilation issues. ## Changes - Create a special `containerfiles/Cargo.toml` file that is derived from the root `Cargo.toml` but with its `default-members` entry removed - Update `containerfiles/Dockerfile` to run `cargo chef prepare` against `containerfiles/Cargo.toml` - Add a just entry to remove `workspace.default-members` from `Cargo.toml`, format it with `taplo`, and write it to `containerfiles/Cargo.toml` - Add a github job that ensures that `containerfiles/Cargo.toml` is in sync with `Cargo.toml` ## Testing - Docker builds were broken and now work again (verified by building locally and in CI) - Commited a modified `containerfiles/Cargo.toml` and observed the github action trigger ## Related Issues PR causing the build to break: astriaorg/astria#664
AngieD101
added a commit
to AngieD101/astria
that referenced
this pull request
Oct 10, 2025
## Summary Build images using a Cargo.toml without a default-members entry. ## Background We use cargo-chef to prepare recipes for each individual binary so that only its dependencies are built and cached. PR astriaorg/astria#664 introduced the `default-members` entry so that cargo invocations by default don't target the lints (as they require a nightly compiler). But this breaks cargo-chef because it leaves default-members intact, leading to cargo compilation issues. ## Changes - Create a special `containerfiles/Cargo.toml` file that is derived from the root `Cargo.toml` but with its `default-members` entry removed - Update `containerfiles/Dockerfile` to run `cargo chef prepare` against `containerfiles/Cargo.toml` - Add a just entry to remove `workspace.default-members` from `Cargo.toml`, format it with `taplo`, and write it to `containerfiles/Cargo.toml` - Add a github job that ensures that `containerfiles/Cargo.toml` is in sync with `Cargo.toml` ## Testing - Docker builds were broken and now work again (verified by building locally and in CI) - Commited a modified `containerfiles/Cargo.toml` and observed the github action trigger ## Related Issues PR causing the build to break: astriaorg/astria#664
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Add a custom lint using the
dylinttool to detect and warn about debug-formatted fields in tracing events.Background
Debug-formatted fields in tracing events are bad practice. They are hard to read and parse, and they surface language-specific implementation details that have no place in observability.
The present lint only acts on debug-formatted fields in
tracing::event!macros (which includes macros likeinfo!andwarn!that are implemented in terms of it). Debug-formatted fields in#[instrument]proc macros will be detected in a separate lint.Changes
tracing::event!macrosdefault-membersfield to the virtual workspace so that the lints are exempt from most CI jobs (the lints require a nightly rust)Testing
This patch provides
compiletest-rsmacros that correctly detects debug-formatted fields in event macros and not in instrument-proc-macros.