stabilize worker_total_busy_duration

tokio/src/runtime/metrics/batch.rs

@@ -1,34 +1,47 @@
-use crate::runtime::metrics::{HistogramBatch, WorkerMetrics};
+use crate::runtime::metrics::WorkerMetrics;
+
+cfg_unstable_metrics! {
+    use crate::runtime::metrics::HistogramBatch;
+}
 
 use std::sync::atomic::Ordering::Relaxed;
 use std::time::{Duration, Instant};
 
 pub(crate) struct MetricsBatch {
+    #[cfg(tokio_unstable)]
     /// Number of times the worker parked.
     park_count: u64,
 
+    #[cfg(tokio_unstable)]
     /// Number of times the worker parked and unparked.
     park_unpark_count: u64,
 
+    #[cfg(tokio_unstable)]
     /// Number of times the worker woke w/o doing work.
     noop_count: u64,
 
+    #[cfg(tokio_unstable)]
     /// Number of tasks stolen.
     steal_count: u64,
 
+    #[cfg(tokio_unstable)]
     /// Number of times tasks where stolen.
     steal_operations: u64,
 
+    #[cfg(tokio_unstable)]
     /// Number of tasks that were polled by the worker.
     poll_count: u64,
 
+    #[cfg(tokio_unstable)]
     /// Number of tasks polled when the worker entered park. This is used to
     /// track the noop count.
     poll_count_on_last_park: u64,
 
+    #[cfg(tokio_unstable)]
     /// Number of tasks that were scheduled locally on this worker.
     local_schedule_count: u64,
 
+    #[cfg(tokio_unstable)]
     /// Number of tasks moved to the global queue to make space in the local
     /// queue
     overflow_count: u64,
@@ -39,87 +52,107 @@ pub(crate) struct MetricsBatch {
     /// Instant at which work last resumed (continued after park).
     processing_scheduled_tasks_started_at: Instant,
 
+    #[cfg(tokio_unstable)]
     /// If `Some`, tracks poll times in nanoseconds
     poll_timer: Option<PollTimer>,
 }
 
-struct PollTimer {
-    /// Histogram of poll counts within each band.
-    poll_counts: HistogramBatch,
+cfg_unstable_metrics! {
+    struct PollTimer {
+        /// Histogram of poll counts within each band.
+        poll_counts: HistogramBatch,
 
-    /// Instant when the most recent task started polling.
-    poll_started_at: Instant,
+        /// Instant when the most recent task started polling.
+        poll_started_at: Instant,
+    }
 }
 
 impl MetricsBatch {
-    pub(crate) fn new(worker_metrics: &WorkerMetrics) -> MetricsBatch {
+    pub(crate) fn new(_worker_metrics: &WorkerMetrics) -> MetricsBatch {
         let now = Instant::now();
+        #[cfg(not(tokio_unstable))]
+        {
+            MetricsBatch {
+                busy_duration_total: 0,
+                processing_scheduled_tasks_started_at: now,
+            }
+        }
 
-        MetricsBatch {
-            park_count: 0,
-            park_unpark_count: 0,
-            noop_count: 0,
-            steal_count: 0,
-            steal_operations: 0,
-            poll_count: 0,
-            poll_count_on_last_park: 0,
-            local_schedule_count: 0,
-            overflow_count: 0,
-            busy_duration_total: 0,
-            processing_scheduled_tasks_started_at: now,
-            poll_timer: worker_metrics
-                .poll_count_histogram
-                .as_ref()
-                .map(|worker_poll_counts| PollTimer {
-                    poll_counts: HistogramBatch::from_histogram(worker_poll_counts),
-                    poll_started_at: now,
-                }),
+        #[cfg(tokio_unstable)]
+        {
+            MetricsBatch {
+                park_count: 0,
+                park_unpark_count: 0,
+                noop_count: 0,
+                steal_count: 0,
+                steal_operations: 0,
+                poll_count: 0,
+                poll_count_on_last_park: 0,
+                local_schedule_count: 0,
+                overflow_count: 0,
+                busy_duration_total: 0,
+                processing_scheduled_tasks_started_at: now,
+                poll_timer: _worker_metrics.poll_count_histogram.as_ref().map(
+                    |worker_poll_counts| PollTimer {
+                        poll_counts: HistogramBatch::from_histogram(worker_poll_counts),
+                        poll_started_at: now,
+                    },
+                ),
+            }
         }
     }
 
-    pub(crate) fn submit(&mut self, worker: &WorkerMetrics, mean_poll_time: u64) {
-        worker.mean_poll_time.store(mean_poll_time, Relaxed);
-        worker.park_count.store(self.park_count, Relaxed);
-        worker
-            .park_unpark_count
-            .store(self.park_unpark_count, Relaxed);
-        worker.noop_count.store(self.noop_count, Relaxed);
-        worker.steal_count.store(self.steal_count, Relaxed);
-        worker
-            .steal_operations
-            .store(self.steal_operations, Relaxed);
-        worker.poll_count.store(self.poll_count, Relaxed);
-
+    pub(crate) fn submit(&mut self, worker: &WorkerMetrics, _mean_poll_time: u64) {
+        #[cfg(tokio_unstable)]
+        {
+            worker.mean_poll_time.store(_mean_poll_time, Relaxed);
+            worker.park_count.store(self.park_count, Relaxed);
+            worker
+                .park_unpark_count
+                .store(self.park_unpark_count, Relaxed);
+            worker.noop_count.store(self.noop_count, Relaxed);
+            worker.steal_count.store(self.steal_count, Relaxed);
+            worker
+                .steal_operations
+                .store(self.steal_operations, Relaxed);
+            worker.poll_count.store(self.poll_count, Relaxed);
+
+            worker
+                .local_schedule_count
+                .store(self.local_schedule_count, Relaxed);
+            worker.overflow_count.store(self.overflow_count, Relaxed);
+
+            if let Some(poll_timer) = &self.poll_timer {
+                let dst = worker.poll_count_histogram.as_ref().unwrap();
+                poll_timer.poll_counts.submit(dst);
+            }
+        }
         worker
             .busy_duration_total
             .store(self.busy_duration_total, Relaxed);
-
-        worker
-            .local_schedule_count
-            .store(self.local_schedule_count, Relaxed);
-        worker.overflow_count.store(self.overflow_count, Relaxed);
-
-        if let Some(poll_timer) = &self.poll_timer {
-            let dst = worker.poll_count_histogram.as_ref().unwrap();
-            poll_timer.poll_counts.submit(dst);
-        }
     }
 
     /// The worker is about to park.
     pub(crate) fn about_to_park(&mut self) {
-        self.park_count += 1;
-        self.park_unpark_count += 1;
-
-        if self.poll_count_on_last_park == self.poll_count {
-            self.noop_count += 1;
-        } else {
-            self.poll_count_on_last_park = self.poll_count;
+        #[cfg(tokio_unstable)]
+        {
+            self.park_count += 1;
+            self.park_unpark_count += 1;
+
+            if self.poll_count_on_last_park == self.poll_count {
+                self.noop_count += 1;
+            } else {
+                self.poll_count_on_last_park = self.poll_count;
+            }
         }
     }
 
     /// The worker was unparked.
     pub(crate) fn unparked(&mut self) {
-        self.park_unpark_count += 1;
+        #[cfg(tokio_unstable)]
+        {
+            self.park_unpark_count += 1;
+        }
     }
 
     /// Start processing a batch of tasks
@@ -135,38 +168,50 @@ impl MetricsBatch {
 
     /// Start polling an individual task
     pub(crate) fn start_poll(&mut self) {
-        self.poll_count += 1;
-
-        if let Some(poll_timer) = &mut self.poll_timer {
-            poll_timer.poll_started_at = Instant::now();
+        #[cfg(tokio_unstable)]
+        {
+            self.poll_count += 1;
+            if let Some(poll_timer) = &mut self.poll_timer {
+                poll_timer.poll_started_at = Instant::now();
+            }
         }
     }
 
     /// Stop polling an individual task
     pub(crate) fn end_poll(&mut self) {
+        #[cfg(tokio_unstable)]
         if let Some(poll_timer) = &mut self.poll_timer {
             let elapsed = duration_as_u64(poll_timer.poll_started_at.elapsed());
             poll_timer.poll_counts.measure(elapsed, 1);
         }
     }
 
     pub(crate) fn inc_local_schedule_count(&mut self) {
-        self.local_schedule_count += 1;
+        #[cfg(tokio_unstable)]
+        {
+            self.local_schedule_count += 1;
+        }
     }
 }
 
 cfg_rt_multi_thread! {
     impl MetricsBatch {
-        pub(crate) fn incr_steal_count(&mut self, by: u16) {
-            self.steal_count += by as u64;
+        pub(crate) fn incr_steal_count(&mut self, _by: u16) {
+            #[cfg(tokio_unstable)] {
+                self.steal_count += _by as u64;
+            }
         }
 
         pub(crate) fn incr_steal_operations(&mut self) {
-            self.steal_operations += 1;
+            #[cfg(tokio_unstable)] {
+                self.steal_operations += 1;
+            }
         }
 
         pub(crate) fn incr_overflow_count(&mut self) {
-            self.overflow_count += 1;
+            #[cfg(tokio_unstable)] {
+                self.overflow_count += 1;
+            }
         }
     }
 }

tokio/src/runtime/metrics/mock.rs

@@ -1,32 +1,7 @@
 //! This file contains mocks of the types in src/runtime/metrics
 
-use crate::runtime::WorkerMetrics;
-use std::sync::atomic::Ordering::Relaxed;
-use std::time::{Duration, Instant};
-
 pub(crate) struct SchedulerMetrics {}
 
-/// The `MetricsBatch` struct in this mock implementation provides a minimal,
-/// simplified version of `batch::MetricsBatch`. It contains only the basic fields
-/// required to track the total busy duration (`busy_duration_total`) .
-///
-/// This mock is used to stabilize the API `worker_total_busy_duration`
-/// without relying on the full metrics collection logic. In the real implementation,
-/// additional fields provide more detailed tracking of worker activity.
-///
-/// This mock can be further enriched when stabilizing other worker metrics, such as
-/// `worker_thread_id`, `worker_park_count` and so on
-///
-/// When more worker metrics are stabilized, we can remove this mock and switch back
-/// to `batch::MetricsBatch`
-pub(crate) struct MetricsBatch {
-    /// The total busy duration in nanoseconds.
-    busy_duration_total: u64,
-
-    /// Instant at which work last resumed (continued after park).
-    processing_scheduled_tasks_started_at: Instant,
-}
-
 #[derive(Clone, Default)]
 pub(crate) struct HistogramBuilder {}
 
@@ -38,44 +13,3 @@ impl SchedulerMetrics {
     /// Increment the number of tasks scheduled externally
     pub(crate) fn inc_remote_schedule_count(&self) {}
 }
-
-impl MetricsBatch {
-    pub(crate) fn new(_: &WorkerMetrics) -> Self {
-        let now = Instant::now();
-
-        MetricsBatch {
-            busy_duration_total: 0,
-            processing_scheduled_tasks_started_at: now,
-        }
-    }
-
-    pub(crate) fn submit(&mut self, worker: &WorkerMetrics, _mean_poll_time: u64) {
-        worker
-            .busy_duration_total
-            .store(self.busy_duration_total, Relaxed);
-    }
-    pub(crate) fn about_to_park(&mut self) {}
-    pub(crate) fn unparked(&mut self) {}
-    pub(crate) fn inc_local_schedule_count(&mut self) {}
-    pub(crate) fn start_processing_scheduled_tasks(&mut self) {
-        self.processing_scheduled_tasks_started_at = Instant::now();
-    }
-    pub(crate) fn end_processing_scheduled_tasks(&mut self) {
-        let busy_duration = self.processing_scheduled_tasks_started_at.elapsed();
-        self.busy_duration_total += duration_as_u64(busy_duration);
-    }
-    pub(crate) fn start_poll(&mut self) {}
-    pub(crate) fn end_poll(&mut self) {}
-}
-
-cfg_rt_multi_thread! {
-    impl MetricsBatch {
-        pub(crate) fn incr_steal_count(&mut self, _by: u16) {}
-        pub(crate) fn incr_steal_operations(&mut self) {}
-        pub(crate) fn incr_overflow_count(&mut self) {}
-    }
-}
-
-fn duration_as_u64(dur: Duration) -> u64 {
-    u64::try_from(dur.as_nanos()).unwrap_or(u64::MAX)
-}

tokio/src/runtime/metrics/mod.rs

@@ -38,6 +38,9 @@ cfg_not_unstable_metrics! {
     mod worker;
     pub(crate) use worker::WorkerMetrics;
 
+    mod batch;
+    pub(crate) use batch::MetricsBatch;
+
     mod mock;
-    pub(crate) use mock::{SchedulerMetrics, MetricsBatch, HistogramBuilder};
+    pub(crate) use mock::{SchedulerMetrics, HistogramBuilder};
 }