Moving repo to fuel-telemetry #1
Conversation
…d start a FileWatcher in one step
| /// | ||
| /// This function does the following: | ||
| /// - Creates a new `TelemetryLayer` `tracing` `Layer` | ||
| /// - Sets it as the global default `tracing` `Subscriber` |
There was a problem hiding this comment.
This sounds like it would override the subscriber from forc-tracing since there can only be one global default. Have you tested using both of them together?
Maybe instead of telemetry_init, this should be built in to init_tracing_subscriber in forc-tracing? There could be an option like telemetry: bool that when true, initializes with the custom layer that has .with_span_events(FmtSpan::CLOSE) to capture duration of #[instrument]ed functions
That way, it would be as simple as adding the telemetry: true option to any tools that already use forc-tracing. What do you think?
| pub fn telemetry_init() -> Result<()> { | ||
| static TELEMETRY_INIT: LazyLock<Result<(WorkerGuard, Span)>> = LazyLock::new(|| { | ||
| let guard = TelemetryLayer::new_global_default_with_watchers()?; | ||
| let main_span = span!(Level::ERROR, "main", telemetry = true); |
| .with(stdout_layer); | ||
|
|
||
| // Set our subscriber as the default global subscriber | ||
| tracing::subscriber::set_global_default(subscriber).unwrap(); |
There was a problem hiding this comment.
https://docs.rs/tracing/latest/tracing/index.html#in-executables
Warning: In general, libraries should not call set_global_default()! Doing so will cause conflicts when executables that depend on the library try to set the default later.
There was a problem hiding this comment.
Maybe we can wrap this one, and utilize type system to make downstream aware of this fact and make it a hard compile error if they try to use it in a library.
pub struct Binary;
pub struct Library;
pub trait CanSetGlobal {}
impl CanSetGlobal for Binary {}
pub fn set_global_subscriber<T>(
_crate_type: T,
subscriber: impl tracing::Subscriber + Send + Sync + 'static,
) where
T: CanSetGlobal,
{
tracing::subscriber::set_global_default(subscriber).unwrap();
}The downside of this is unfortunately there is no way to detect crate type in compile time.
So this would be used like:
// In binary - compiles:
set_global_subscriber(Binary, my_subscriber);
// In library - compile error because `Library` doesn't implement `CanSetGlobal`:
set_global_subscriber(Library, my_subscriber);
| // Time to enable telemetry from now on by setting telemetry=true on a `Span` | ||
| let enabled_span = span!(Level::INFO, "root", telemetry=true); | ||
| let _span_guard = enabled_span.enter(); |
There was a problem hiding this comment.
https://docs.rs/tracing/latest/tracing/struct.Span.html#method.entered can be used to ge this in single line
let _span_guard = span!(Level::INFO, "root", telemetry=true).entered();
|
|
||
| Telemetry files on disk are stored Base64 encoded. To peek into them: | ||
|
|
||
| cat ~/.fuelup/tmp/*.telemetry.* | while read line; do echo "$line" | base64 -d; echo; done |
There was a problem hiding this comment.
nit: wrap in markdown script:
| cat ~/.fuelup/tmp/*.telemetry.* | while read line; do echo "$line" | base64 -d; echo; done | |
| ```sh | |
| cat ~/.fuelup/tmp/*.telemetry.* | while read line; do echo "$line" | base64 -d; echo; done |
| for f in ~/.fuelup/tmp/*.telemetry.*; do mv "$f" "$f.old"; done | ||
| touch -t 202501010101 ~/.fuelup/tmp/* |
There was a problem hiding this comment.
nit: also wrap in markdown sh here too
There was a problem hiding this comment.
could be useful to have a docker command (or nix-shell command?) - to view/query the telemetry locally collected.
This would also help with debugging, testing and validating local collected traces - before sending them over the wire.
This PR carries over all the rewrite commits from
forc-telemetry, and changes the repo name tofuel-telemetry.