Skip to content

Commit 191eaf6

Browse files
committed
chore: bump metric doc links in README to 0.4.x, add missing rt::blocking_queue_depth link
1 parent c1185b0 commit 191eaf6

File tree

1 file changed

+64
-63
lines changed

1 file changed

+64
-63
lines changed

README.md

Lines changed: 64 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -98,34 +98,34 @@ loop {
9898
- **[`mean_long_delay_duration`]**
9999
The mean duration of long schedules.
100100

101-
[`instrumented_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.instrumented_count
102-
[`dropped_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.dropped_count
103-
[`first_poll_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.first_poll_count
104-
[`total_first_poll_delay`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_first_poll_delay
105-
[`total_idled_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_idled_count
106-
[`total_idle_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_idle_duration
107-
[`total_scheduled_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_scheduled_count
108-
[`total_scheduled_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_scheduled_duration
109-
[`total_poll_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_poll_count
110-
[`total_poll_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_poll_duration
111-
[`total_fast_poll_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_fast_poll_count
112-
[`total_fast_poll_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_fast_poll_duration
113-
[`total_slow_poll_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_slow_poll_count
114-
[`total_slow_poll_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_slow_poll_duration
115-
[`mean_first_poll_delay`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#method.mean_first_poll_delay
116-
[`mean_idle_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#method.mean_idle_duration
117-
[`mean_scheduled_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#method.mean_scheduled_duration
118-
[`mean_poll_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#method.mean_poll_duration
119-
[`slow_poll_ratio`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#method.slow_poll_ratio
120-
[`mean_fast_poll_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#method.mean_fast_poll_duration
121-
[`mean_slow_poll_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#method.mean_slow_poll_duration
122-
[`total_short_delay_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_short_delay_count
123-
[`total_short_delay_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_short_delay_duration
124-
[`total_long_delay_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_long_delay_count
125-
[`total_long_delay_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_long_delay_duration
126-
[`long_delay_ratio`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#method.long_delay_ratio
127-
[`mean_short_delay_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#method.mean_short_delay_duration
128-
[`mean_long_delay_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.TaskMetrics.html#method.mean_long_delay_duration
101+
[`instrumented_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.instrumented_count
102+
[`dropped_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.dropped_count
103+
[`first_poll_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.first_poll_count
104+
[`total_first_poll_delay`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_first_poll_delay
105+
[`total_idled_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_idled_count
106+
[`total_idle_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_idle_duration
107+
[`total_scheduled_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_scheduled_count
108+
[`total_scheduled_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_scheduled_duration
109+
[`total_poll_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_poll_count
110+
[`total_poll_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_poll_duration
111+
[`total_fast_poll_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_fast_poll_count
112+
[`total_fast_poll_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_fast_poll_duration
113+
[`total_slow_poll_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_slow_poll_count
114+
[`total_slow_poll_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_slow_poll_duration
115+
[`mean_first_poll_delay`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#method.mean_first_poll_delay
116+
[`mean_idle_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#method.mean_idle_duration
117+
[`mean_scheduled_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#method.mean_scheduled_duration
118+
[`mean_poll_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#method.mean_poll_duration
119+
[`slow_poll_ratio`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#method.slow_poll_ratio
120+
[`mean_fast_poll_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#method.mean_fast_poll_duration
121+
[`mean_slow_poll_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#method.mean_slow_poll_duration
122+
[`total_short_delay_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_short_delay_count
123+
[`total_short_delay_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_short_delay_duration
124+
[`total_long_delay_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_long_delay_count
125+
[`total_long_delay_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#structfield.total_long_delay_duration
126+
[`long_delay_ratio`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#method.long_delay_ratio
127+
[`mean_short_delay_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#method.mean_short_delay_duration
128+
[`mean_long_delay_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.TaskMetrics.html#method.mean_long_delay_duration
129129

130130
## Getting Started With Runtime Metrics
131131

@@ -256,41 +256,42 @@ tokio::spawn(do_work());
256256
- **[`mean_polls_per_park`]**
257257
- **[`busy_ratio`]**
258258

259-
[`workers_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.workers_count
260-
[`total_park_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_park_count
261-
[`max_park_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_park_count
262-
[`min_park_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_park_count
263-
[`total_noop_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_noop_count
264-
[`max_noop_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_noop_count
265-
[`min_noop_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_noop_count
266-
[`total_steal_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_steal_count
267-
[`max_steal_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_steal_count
268-
[`min_steal_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_steal_count
269-
[`total_steal_operations`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_steal_operations
270-
[`max_steal_operations`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_steal_operations
271-
[`min_steal_operations`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_steal_operations
272-
[`num_remote_schedules`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.num_remote_schedules
273-
[`total_local_schedule_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_local_schedule_count
274-
[`max_local_schedule_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_local_schedule_count
275-
[`min_local_schedule_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_local_schedule_count
276-
[`total_overflow_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_overflow_count
277-
[`max_overflow_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_overflow_count
278-
[`min_overflow_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_overflow_count
279-
[`total_polls_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_polls_count
280-
[`max_polls_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_polls_count
281-
[`min_polls_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_polls_count
282-
[`total_busy_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_busy_duration
283-
[`max_busy_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_busy_duration
284-
[`min_busy_duration`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_busy_duration
285-
[`injection_queue_depth`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.injection_queue_depth
286-
[`total_local_queue_depth`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_local_queue_depth
287-
[`max_local_queue_depth`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_local_queue_depth
288-
[`min_local_queue_depth`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_local_queue_depth
289-
[`elapsed`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.elapsed
290-
[`mean_polls_per_park`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#method.mean_polls_per_park
291-
[`busy_ratio`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#method.busy_ratio
292-
[`budget_forced_yield_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.budget_forced_yield_count
293-
[`io_driver_ready_count`]: https://docs.rs/tokio-metrics/0.3.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.io_driver_ready_count
259+
[`workers_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.workers_count
260+
[`total_park_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_park_count
261+
[`max_park_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_park_count
262+
[`min_park_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_park_count
263+
[`total_noop_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_noop_count
264+
[`max_noop_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_noop_count
265+
[`min_noop_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_noop_count
266+
[`total_steal_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_steal_count
267+
[`max_steal_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_steal_count
268+
[`min_steal_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_steal_count
269+
[`total_steal_operations`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_steal_operations
270+
[`max_steal_operations`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_steal_operations
271+
[`min_steal_operations`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_steal_operations
272+
[`num_remote_schedules`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.num_remote_schedules
273+
[`total_local_schedule_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_local_schedule_count
274+
[`max_local_schedule_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_local_schedule_count
275+
[`min_local_schedule_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_local_schedule_count
276+
[`total_overflow_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_overflow_count
277+
[`max_overflow_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_overflow_count
278+
[`min_overflow_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_overflow_count
279+
[`total_polls_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_polls_count
280+
[`max_polls_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_polls_count
281+
[`min_polls_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_polls_count
282+
[`total_busy_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_busy_duration
283+
[`max_busy_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_busy_duration
284+
[`min_busy_duration`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_busy_duration
285+
[`injection_queue_depth`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.injection_queue_depth
286+
[`total_local_queue_depth`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.total_local_queue_depth
287+
[`blocking_queue_depth`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.blocking_queue_depth
288+
[`max_local_queue_depth`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.max_local_queue_depth
289+
[`min_local_queue_depth`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.min_local_queue_depth
290+
[`elapsed`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.elapsed
291+
[`mean_polls_per_park`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#method.mean_polls_per_park
292+
[`busy_ratio`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#method.busy_ratio
293+
[`budget_forced_yield_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.budget_forced_yield_count
294+
[`io_driver_ready_count`]: https://docs.rs/tokio-metrics/0.4.*/tokio_metrics/struct.RuntimeMetrics.html#structfield.io_driver_ready_count
294295

295296

296297
## Relation to Tokio Console

0 commit comments

Comments
 (0)