Skip to content
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

metrics: rename injection_queue_depth to global_queue_depth #6918

Merged
merged 3 commits into from
Oct 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 13 additions & 6 deletions tokio/src/runtime/metrics/runtime.rs
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,11 @@ impl RuntimeMetrics {
}

/// Returns the number of tasks currently scheduled in the runtime's
/// injection queue.
/// global queue.
///
/// Tasks that are spawned or notified from a non-runtime thread are
/// scheduled using the runtime's injection queue. This metric returns the
/// **current** number of tasks pending in the injection queue. As such, the
/// scheduled using the runtime's global queue. This metric returns the
/// **current** number of tasks pending in the global queue. As such, the
/// returned value may increase or decrease as new tasks are scheduled and
/// processed.
///
Expand All @@ -88,11 +88,11 @@ impl RuntimeMetrics {
/// async fn main() {
/// let metrics = Handle::current().metrics();
///
/// let n = metrics.injection_queue_depth();
/// println!("{} tasks currently pending in the runtime's injection queue", n);
/// let n = metrics.global_queue_depth();
/// println!("{} tasks currently pending in the runtime's global queue", n);
/// }
/// ```
pub fn injection_queue_depth(&self) -> usize {
pub fn global_queue_depth(&self) -> usize {
self.handle.inner.injection_queue_depth()
}

Expand Down Expand Up @@ -681,6 +681,13 @@ impl RuntimeMetrics {
}
}

/// Renamed to [`RuntimeMetrics::global_queue_depth`]
#[deprecated = "Renamed to global_queue_depth"]
#[doc(hidden)]
pub fn injection_queue_depth(&self) -> usize {
mox692 marked this conversation as resolved.
Show resolved Hide resolved
self.handle.inner.injection_queue_depth()
}

/// Returns the number of tasks currently scheduled in the given worker's
/// local queue.
///
Expand Down
8 changes: 4 additions & 4 deletions tokio/tests/rt_metrics.rs
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ fn num_alive_tasks() {
}

#[test]
fn injection_queue_depth_current_thread() {
fn global_queue_depth_current_thread() {
use std::thread;

let rt = current_thread();
Expand All @@ -60,11 +60,11 @@ fn injection_queue_depth_current_thread() {
.join()
.unwrap();

assert_eq!(1, metrics.injection_queue_depth());
assert_eq!(1, metrics.global_queue_depth());
}

#[test]
fn injection_queue_depth_multi_thread() {
fn global_queue_depth_multi_thread() {
let rt = threaded();
let metrics = rt.metrics();

Expand All @@ -85,7 +85,7 @@ fn injection_queue_depth_multi_thread() {

let mut fail: Option<String> = None;
for i in 0..10 {
let depth = metrics.injection_queue_depth();
let depth = metrics.global_queue_depth();
if i != depth {
fail = Some(format!("{i} is not equal to {depth}"));
break;
Expand Down
Loading