[Rust] Replace log with tracing
#7808
Open
+1,436
−1,025
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
Member
Author
|
Resolves #6863 |
emesare
force-pushed
the
test_rust_tracing
branch
from
76a789c to
93aa1a8
Compare
Member
Author
|
Force pushed removing explicit targets in log calls, replaced with rewrite rules within the registered tracing |
emesare
force-pushed
the
test_rust_tracing
branch
from
f151812 to
9717943
Compare
Member
Author
|
Migration guide:
diff --git a/plugins/pdb-ng/Cargo.toml b/plugins/pdb-ng/Cargo.toml
--- a/plugins/pdb-ng/Cargo.toml
+++ b/plugins/pdb-ng/Cargo.toml
@@ -16,1 +16,2 @@
regex = "1"
+tracing = "0.1"
diff --git a/plugins/warp/src/plugin/load.rs b/plugins/warp/src/plugin/load.rs
--- a/plugins/warp/src/plugin/load.rs
+++ b/plugins/warp/src/plugin/load.rs
@@ -132,4 +133,4 @@
Err(e) => {
- log::error!("Failed to read signature file: {}", e);
+ tracing::error!("Failed to read signature file: {}", e);
return;
}
diff --git a/plugins/pdb-ng/src/lib.rs b/plugins/pdb-ng/src/lib.rs
--- a/plugins/pdb-ng/src/lib.rs
+++ b/plugins/pdb-ng/src/lib.rs
@@ -721,1 +729,1 @@
- Logger::new("PDB").init();
+ binaryninja::tracing_init!("PDB Import"); |
emesare
force-pushed
the
test_rust_tracing
branch
from
087f6f9 to
77ebe1b
Compare
emesare
force-pushed
the
test_rust_tracing
branch
from
77ebe1b to
8b57060
Compare
- Added more documentation - Replaced global named logger for plugins, fixing the issue when the CU has multiple (e.g. statically linked demo) - Simplified some misc code This is a breaking change, but I believe there is no better time to make it, we cannot continue to use the `log` crate, it is too limited for our needs.
…ary view callbacks
Would be really nice if we consolidated this somewhere so this does not keep happening
Assign the `session_id` span field before calling into the relocation handler so logs get scoped to the specific view.
emesare
force-pushed
the
test_rust_tracing
branch
from
8b57060 to
8783ae1
Compare
bdash
approved these changes
Dec 30, 2025
Contributor
bdash
left a comment
bdash
left a comment
There was a problem hiding this comment.
LGTM, with some minor comments.
| binaryninja = { path = "../.." } | ||
| uuid = "1.18.1" | ||
| log = "0.4.27" | ||
| tracing = "0.1" |
Contributor
There was a problem hiding this comment.
May as well leave the newline at EOF here.
| /// # Example | ||
| /// | ||
| /// Given the target "my_crate::commands::analyze" the target will be rewritten to "MyCrate.Commands.Analyze". | ||
| pub formatted_target: bool, |
Contributor
There was a problem hiding this comment.
This is describing behavior that will be taken, so I think it should be format rather than formatted.
| /// target will be rewritten to "MyPlugin::commands::analyze", assuming no other rewrites occur. | ||
| pub target_mappings: Vec<(String, String)>, | ||
| /// Whether the default target should be formatted to be displayed in the "common" logger name | ||
| /// format for Binary Ninja. This formatting does _not_ apply to targets explicitly set, rather |
Contributor
There was a problem hiding this comment.
It might be clearer to phrase this in the positive. Something like: "This formatting will only be applied when the target name is implicit. Explicitly provided target names will be preserved as-is."
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.
Explicitly name the target for the log event, this is how it must be done to guarantee we send it to the correct onesession_idevent field, to send logs to a particular session (e.g. binary view scoped logs)This is a breaking change, but I believe there is no better time to make it, we cannot continue to use the
logcrate, it is too limited for our needs.Still need to finish docs and cross link more between theloggermodule and thetracingmodule, as well as provide some examples in the top level module docs.Still need to place more session id spans in relevant callbacks so that they automatically get scoped to a bv.TBD if we keep the tracing re-exports for the macros, we might instead let callers use the non re-exported version. or we might move the code intologgerand then re-export tracing at the top level, or we might not re-export at all and assume the caller includestracingin Cargo.toml.