-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
sync: avoid creating resource spans with curernt parent, use a None p…
…arent instead (#6107) A child span stored on sync primitives can keep the parent span open, unable to be closed by subscribers due to the sync resource referencing it. Fixes: #6106 Co-authored-by: David Barsky <[email protected]>
- Loading branch information
1 parent
135d7ca
commit 7b55518
Showing
7 changed files
with
255 additions
and
0 deletions.
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,248 @@ | ||
//! Tests for sync instrumentation. | ||
//! | ||
//! These tests ensure that the instrumentation for tokio | ||
//! synchronization primitives is correct. | ||
use tokio::sync; | ||
use tracing_mock::{expect, subscriber}; | ||
|
||
#[tokio::test] | ||
async fn test_barrier_creates_span() { | ||
let barrier_span = expect::span() | ||
.named("runtime.resource") | ||
.with_target("tokio::sync::barrier"); | ||
|
||
let size_event = expect::event() | ||
.with_target("runtime::resource::state_update") | ||
.with_fields(expect::field("size").with_value(&1u64)); | ||
|
||
let arrived_event = expect::event() | ||
.with_target("runtime::resource::state_update") | ||
.with_fields(expect::field("arrived").with_value(&0)); | ||
|
||
let (subscriber, handle) = subscriber::mock() | ||
.new_span(barrier_span.clone().with_explicit_parent(None)) | ||
.enter(barrier_span.clone()) | ||
.event(size_event) | ||
.event(arrived_event) | ||
.exit(barrier_span.clone()) | ||
.drop_span(barrier_span) | ||
.run_with_handle(); | ||
|
||
{ | ||
let _guard = tracing::subscriber::set_default(subscriber); | ||
let _ = sync::Barrier::new(1); | ||
} | ||
|
||
handle.assert_finished(); | ||
} | ||
|
||
#[tokio::test] | ||
async fn test_mutex_creates_span() { | ||
let mutex_span = expect::span() | ||
.named("runtime.resource") | ||
.with_target("tokio::sync::mutex"); | ||
|
||
let locked_event = expect::event() | ||
.with_target("runtime::resource::state_update") | ||
.with_fields(expect::field("locked").with_value(&false)); | ||
|
||
let batch_semaphore_span = expect::span() | ||
.named("runtime.resource") | ||
.with_target("tokio::sync::batch_semaphore"); | ||
|
||
let batch_semaphore_permits_event = expect::event() | ||
.with_target("runtime::resource::state_update") | ||
.with_fields(expect::field("permits").with_value(&1u64)) | ||
.with_fields(expect::field("permits.op").with_value(&"override")); | ||
|
||
let (subscriber, handle) = subscriber::mock() | ||
.new_span(mutex_span.clone().with_explicit_parent(None)) | ||
.enter(mutex_span.clone()) | ||
.event(locked_event) | ||
.new_span(batch_semaphore_span.clone()) | ||
.enter(batch_semaphore_span.clone()) | ||
.event(batch_semaphore_permits_event) | ||
.exit(batch_semaphore_span.clone()) | ||
.exit(mutex_span.clone()) | ||
.drop_span(mutex_span) | ||
.drop_span(batch_semaphore_span) | ||
.run_with_handle(); | ||
|
||
{ | ||
let _guard = tracing::subscriber::set_default(subscriber); | ||
let _ = sync::Mutex::new(true); | ||
} | ||
|
||
handle.assert_finished(); | ||
} | ||
|
||
#[tokio::test] | ||
async fn test_oneshot_creates_span() { | ||
let oneshot_span = expect::span() | ||
.named("runtime.resource") | ||
.with_target("tokio::sync::oneshot"); | ||
|
||
let initial_tx_dropped_event = expect::event() | ||
.with_target("runtime::resource::state_update") | ||
.with_fields(expect::field("tx_dropped").with_value(&false)) | ||
.with_fields(expect::field("tx_dropped.op").with_value(&"override")); | ||
|
||
let final_tx_dropped_event = expect::event() | ||
.with_target("runtime::resource::state_update") | ||
.with_fields(expect::field("tx_dropped").with_value(&true)) | ||
.with_fields(expect::field("tx_dropped.op").with_value(&"override")); | ||
|
||
let initial_rx_dropped_event = expect::event() | ||
.with_target("runtime::resource::state_update") | ||
.with_fields(expect::field("rx_dropped").with_value(&false)) | ||
.with_fields(expect::field("rx_dropped.op").with_value(&"override")); | ||
|
||
let final_rx_dropped_event = expect::event() | ||
.with_target("runtime::resource::state_update") | ||
.with_fields(expect::field("rx_dropped").with_value(&true)) | ||
.with_fields(expect::field("rx_dropped.op").with_value(&"override")); | ||
|
||
let value_sent_event = expect::event() | ||
.with_target("runtime::resource::state_update") | ||
.with_fields(expect::field("value_sent").with_value(&false)) | ||
.with_fields(expect::field("value_sent.op").with_value(&"override")); | ||
|
||
let value_received_event = expect::event() | ||
.with_target("runtime::resource::state_update") | ||
.with_fields(expect::field("value_received").with_value(&false)) | ||
.with_fields(expect::field("value_received.op").with_value(&"override")); | ||
|
||
let async_op_span = expect::span() | ||
.named("runtime.resource.async_op") | ||
.with_target("tokio::sync::oneshot"); | ||
|
||
let async_op_poll_span = expect::span() | ||
.named("runtime.resource.async_op.poll") | ||
.with_target("tokio::sync::oneshot"); | ||
|
||
let (subscriber, handle) = subscriber::mock() | ||
.new_span(oneshot_span.clone().with_explicit_parent(None)) | ||
.enter(oneshot_span.clone()) | ||
.event(initial_tx_dropped_event) | ||
.exit(oneshot_span.clone()) | ||
.enter(oneshot_span.clone()) | ||
.event(initial_rx_dropped_event) | ||
.exit(oneshot_span.clone()) | ||
.enter(oneshot_span.clone()) | ||
.event(value_sent_event) | ||
.exit(oneshot_span.clone()) | ||
.enter(oneshot_span.clone()) | ||
.event(value_received_event) | ||
.exit(oneshot_span.clone()) | ||
.enter(oneshot_span.clone()) | ||
.new_span(async_op_span.clone()) | ||
.exit(oneshot_span.clone()) | ||
.enter(async_op_span.clone()) | ||
.new_span(async_op_poll_span.clone()) | ||
.exit(async_op_span.clone()) | ||
.enter(oneshot_span.clone()) | ||
.event(final_tx_dropped_event) | ||
.exit(oneshot_span.clone()) | ||
.enter(oneshot_span.clone()) | ||
.event(final_rx_dropped_event) | ||
.exit(oneshot_span.clone()) | ||
.drop_span(oneshot_span) | ||
.drop_span(async_op_span) | ||
.drop_span(async_op_poll_span) | ||
.run_with_handle(); | ||
|
||
{ | ||
let _guard = tracing::subscriber::set_default(subscriber); | ||
let _ = sync::oneshot::channel::<bool>(); | ||
} | ||
|
||
handle.assert_finished(); | ||
} | ||
|
||
#[tokio::test] | ||
async fn test_rwlock_creates_span() { | ||
let rwlock_span = expect::span() | ||
.named("runtime.resource") | ||
.with_target("tokio::sync::rwlock"); | ||
|
||
let max_readers_event = expect::event() | ||
.with_target("runtime::resource::state_update") | ||
.with_fields(expect::field("max_readers").with_value(&0x1FFFFFFF_u64)); | ||
|
||
let write_locked_event = expect::event() | ||
.with_target("runtime::resource::state_update") | ||
.with_fields(expect::field("write_locked").with_value(&false)); | ||
|
||
let current_readers_event = expect::event() | ||
.with_target("runtime::resource::state_update") | ||
.with_fields(expect::field("current_readers").with_value(&0)); | ||
|
||
let batch_semaphore_span = expect::span() | ||
.named("runtime.resource") | ||
.with_target("tokio::sync::batch_semaphore"); | ||
|
||
let batch_semaphore_permits_event = expect::event() | ||
.with_target("runtime::resource::state_update") | ||
.with_fields(expect::field("permits").with_value(&1u64)) | ||
.with_fields(expect::field("permits.op").with_value(&"override")); | ||
|
||
let (subscriber, handle) = subscriber::mock() | ||
.new_span(rwlock_span.clone().with_explicit_parent(None)) | ||
.enter(rwlock_span.clone()) | ||
.event(max_readers_event) | ||
.event(write_locked_event) | ||
.event(current_readers_event) | ||
.exit(rwlock_span.clone()) | ||
.enter(rwlock_span.clone()) | ||
.new_span(batch_semaphore_span.clone()) | ||
.enter(batch_semaphore_span.clone()) | ||
.event(batch_semaphore_permits_event) | ||
.exit(batch_semaphore_span.clone()) | ||
.exit(rwlock_span.clone()) | ||
.drop_span(rwlock_span) | ||
.drop_span(batch_semaphore_span) | ||
.run_with_handle(); | ||
|
||
{ | ||
let _guard = tracing::subscriber::set_default(subscriber); | ||
let _ = sync::RwLock::new(true); | ||
} | ||
|
||
handle.assert_finished(); | ||
} | ||
|
||
#[tokio::test] | ||
async fn test_semaphore_creates_span() { | ||
let semaphore_span = expect::span() | ||
.named("runtime.resource") | ||
.with_target("tokio::sync::semaphore"); | ||
|
||
let batch_semaphore_span = expect::span() | ||
.named("runtime.resource") | ||
.with_target("tokio::sync::batch_semaphore"); | ||
|
||
let batch_semaphore_permits_event = expect::event() | ||
.with_target("runtime::resource::state_update") | ||
.with_fields(expect::field("permits").with_value(&1u64)) | ||
.with_fields(expect::field("permits.op").with_value(&"override")); | ||
|
||
let (subscriber, handle) = subscriber::mock() | ||
.new_span(semaphore_span.clone().with_explicit_parent(None)) | ||
.enter(semaphore_span.clone()) | ||
.new_span(batch_semaphore_span.clone()) | ||
.enter(batch_semaphore_span.clone()) | ||
.event(batch_semaphore_permits_event) | ||
.exit(batch_semaphore_span.clone()) | ||
.exit(semaphore_span.clone()) | ||
.drop_span(semaphore_span) | ||
.drop_span(batch_semaphore_span) | ||
.run_with_handle(); | ||
|
||
{ | ||
let _guard = tracing::subscriber::set_default(subscriber); | ||
let _ = sync::Semaphore::new(1); | ||
} | ||
|
||
handle.assert_finished(); | ||
} |