itsscb/tokio
1
0
Fork 0
mirror of https://github.com/tokio-rs/tokio.git synced 2025-10-01 12:20:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

tracing: change span naming to new console convention (#4042)

Browse Source 
Currently, the per-task spans generated by Tokio's `tracing` feature
have the span name "task" and the target "tokio::task". This is because
the console subscriber identified tasks by looking specifically for the
"tokio::task" target.

In tokio-rs/console#41, it was proposed that the console change to a
more generic system for identifying the spans that correspond to tasks,
to allow recording tasks belonging to multiple runtime crates (e.g. an
application that uses Tokio for async tasks and Rayon for CPU-bound
tasks). PR tokio-rs/console#68 changed the console to track any spans
"runtime.spawn", regardless of target (so that the target can be used to
identify the runtime a task came from), with "tokio::task/task" tracked
for backwards-compatibility with the current release version of tokio.

This branch changes Tokio's span naming to the new convention. I also
rearranged a couple fields so that the task's kind field always comes
before the name and spawn location, since it's likely to be the
shortest, and renamed the `function` field on blocking tasks to `fn`,
for brevity's sake.

Signed-off-by: Eliza Weisman <eliza@buoyant.io>
This commit is contained in:
Eliza Weisman 2021-08-16 12:43:34 -07:00 committed by GitHub
parent 5c19b5a162
commit d0305d57e5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
tokio/src/runtime/handle.rs
View File

@ -192,20 +192,20 @@ impl Handle {
let location = std::panic::Location::caller(); let location = std::panic::Location::caller();
#[cfg(tokio_track_caller)] #[cfg(tokio_track_caller)]
let span = tracing::trace_span!( let span = tracing::trace_span!(
target: "tokio::task", target: "tokio::task::blocking",
"task", "runtime.spawn",
kind = %"blocking", kind = %"blocking",
function = %std::any::type_name::<F>(),
task.name = %name.unwrap_or_default(), task.name = %name.unwrap_or_default(),
"fn" = %std::any::type_name::<F>(),
spawn.location = %format_args!("{}:{}:{}", location.file(), location.line(), location.column()), spawn.location = %format_args!("{}:{}:{}", location.file(), location.line(), location.column()),
); );
#[cfg(not(tokio_track_caller))] #[cfg(not(tokio_track_caller))]
let span = tracing::trace_span!( let span = tracing::trace_span!(
target: "tokio::task", target: "tokio::task::blocking",
"task", "runtime.spawn",
kind = %"blocking", kind = %"blocking",
task.name = %name.unwrap_or_default(), task.name = %name.unwrap_or_default(),
function = %std::any::type_name::<F>(), "fn" = %std::any::type_name::<F>(),
); );
fut.instrument(span) fut.instrument(span)
}; };

8
tokio/src/util/trace.rs
View File

@ -11,17 +11,17 @@ cfg_trace! {
#[cfg(tokio_track_caller)] #[cfg(tokio_track_caller)]
let span = tracing::trace_span!( let span = tracing::trace_span!(
target: "tokio::task", target: "tokio::task",
"task", "runtime.spawn",
%kind, %kind,
task.name = %name.unwrap_or_default(),
spawn.location = %format_args!("{}:{}:{}", location.file(), location.line(), location.column()), spawn.location = %format_args!("{}:{}:{}", location.file(), location.line(), location.column()),
task.name = %name.unwrap_or_default()
); );
#[cfg(not(tokio_track_caller))] #[cfg(not(tokio_track_caller))]
let span = tracing::trace_span!( let span = tracing::trace_span!(
target: "tokio::task", target: "tokio::task",
"task", "runtime.spawn",
%kind, %kind,
task.name = %name.unwrap_or_default() task.name = %name.unwrap_or_default(),
); );
task.instrument(span) task.instrument(span)
} }