task: fix spawn_local source location for console #5984
Conversation
The location of a spawned task, as shown in tokio console, is taken from the location set on the tracing span that instruments the task. For this location to work, there must be unbroken chain of functions instrumented with `#[track_caller]`. For `task::spawn_local`, there was a break in this chain and so the span contained the location of an internal function in tokio. This change adds the missing `#[track_caller]` attribute. It has been tested locally as automated tests would really need `tracing-mock` to be published so we can use it in the tokio tests.
Darksonn
added
A-tokio
|
We have various tests for |
|
Those tests all involve something panicking, which isn't the case here. For this method we would need to check that the recorded span contains the correct value. This is something that we could do with Also I don't know how to make this function panic (in theory I could by calling What I will do, is add tests for this in |
Motivation
The location of a spawned task, as shown in tokio console, is taken from
the location set on the tracing span that instruments the task. For this
location to work, there must be unbroken chain of functions instrumented
with
#[track_caller].For
task::spawn_local, there was a break in this chain and so thespan contained the location of an internal function in tokio.
Solution
This change adds the missing
#[track_caller]attribute. It has beentested locally as automated tests would really need
tracing-mockto bepublished so we can use it in the tokio tests.