-
Notifications
You must be signed in to change notification settings - Fork 23
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
Fix the description of steal_count #35
Conversation
Yeah probably makes sense to only do the stuff we can support right now aka the doc fixes and the rest can go in anothe PR. |
c406088
to
7ababad
Compare
`steal_count` falsely claimed to be the number of times tasks where stolen, but was actually the number of tasks stolen. The description is wrong for all versions of tokio since at least the minimum tokio version tokio-metrics currently supports (v1.15). See: https://github.com/tokio-rs/tokio/blob/f64673580dfc649954eb744eb2734f2f118baa47/tokio/src/runtime/queue.rs#L323
7ababad
to
e164f87
Compare
Updated the PR to only include the documentation changes. |
The documentation fix was merged into tokio in tokio-rs/tokio#5330, so this PR should be ready now too. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks.
There are two test failures, but its not clear whether they're due to your change or just a flaky test. I will rerun the tests now, so we can see whether it's consistent.
|
The test failure is consistent, but also happens on |
The doc test failures are not present using tokio 1.22.0 and appear first with tokio 1.23.0. I bisected and it appears 22862739dddd49a94065aa7a917cde2dc8a3f6bc is the culprit. |
I opened #36 to track this. |
Follow-up to #35. The new metric is available starting with tokio v1.25.0.
# 0.2.0 (March 6th, 2023) ### Added - Add `Debug` implementations. ([#28]) - rt: add concrete `RuntimeIntervals` iterator type ([#26]) - rt: add budget_forced_yield_count metric ([#39]) - rt: add io_driver_ready_count metric ([#40]) - rt: add steal_operations metric ([#37]) - task: also instrument streams ([#31]) ### Documented - doc: fix count in `TaskMonitor` docstring ([#24]) - doc: the description of steal_count ([#35]) [#24]: #24 [#26]: #26 [#28]: #28 [#31]: #31 [#35]: #35 [#37]: #37 [#39]: #39 [#40]: #40
Follow-up to tokio-rs#35. The new metric is available starting with tokio v1.25.0.
steal_count
falsely claimed to be the number of times tasks were stolen, but was actually the number of tasks stolen. Adjust the documentation to reflect this factExpose the newEdit: Removed this part and kept only the documentation changes.steal_operations
metric, which tracks what was previously documented to besteal_count
. This requires #5330, so I guess it might make sense for me to split that part into a separate PR since it requires bumping the minimum supported tokio version.