-
Notifications
You must be signed in to change notification settings - Fork 5.4k
feat: introduce fuel-telemetry macros #7295
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
kayagokalp
wants to merge
20
commits into
master
Choose a base branch
from
kayagokalp/tracing-telem
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
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
zees-dev
reviewed
Jul 28, 2025
zees-dev
reviewed
Aug 26, 2025
zees-dev
reviewed
Aug 26, 2025
forc-tracing/src/telemetry.rs
Outdated
/// Logs an error message to telemetry | ||
#[macro_export] | ||
macro_rules! error_telemetry { | ||
($($arg:tt)*) => {{ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe *
implies 0+
args; I believe we don't want scenario's where there are no args?
Suggested change
($($arg:tt)*) => {{ | |
($($arg:tt)+) => {{ |
If so; may also apply to the macros below aswell
zees-dev
previously approved these changes
Sep 4, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
JoshuaBatty
reviewed
Sep 4, 2025
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.
Description
Add telemetry opt-out support to forc-tracing
This adds
fuel-telemetry
toforc-tracing
(not quite - dependency is currently pointing to Github) with opt-out functionality for upstream tools like fuelup.Usage
First, add it to the
forc-tracing
dependency:Then use the
telemetry::*
glob, followed by the usualtracing
macros, but with a_telemetry
postfix:This will output the following (note
DEBUG
andTRACE
messages are filtered out because ofRUST_LOG=info
):> RUST_LOG=info ./target/debug/example Stop Slow down Go
We can then peek into telemetry files like the following:
New: Telemetry Opt-Out Support
This PR also adds opt-out functionality for telemetry, allowing upstream tools like fuelup to disable telemetry collection:
Changes:
--disable-telemetry
CLI flag to main forc binaryFORC_DISABLE_TELEMETRY
environment variable supportinit_telemetry()
function for proper initializationOpt-out Usage:
Code example with opt-out:
The implementation ensures telemetry is opt-out by default but can be easily disabled through either CLI flags or environment variables, making it suitable for upstream tool integration.