feat(console): surface dropped events if there are any #316
Conversation
There was a problem hiding this comment.
Thanks for working on this, this PR looks like a great start!
One thing I notice is that we're currently only showing the count of dropped async ops, and not dropped tasks or resources. We should probably fix that.
Also, some ideas for the future:
- I had initially wondered if it might be nice to show a count of dropped events as a warning in the warnings UI box, but I think showing it here is fine for now.
- I also wonder if we want to consider showing the number of dropped events over a time window, like
43 events dropped over the last 20 seconds (3489 dropped events total)or something?
But, those can both be addressed in follow-ups --- for now, I think it's important to just actually start showing this data, as it's not currently exposed at all...
During normal operation it won't show anything: ``` connection: http://127.0.0.1:6669/ (CONNECTED) ``` But if there are any drops detected, it will show a cumulative amount: ``` connection: http://127.0.0.1:6669/ (CONNECTED) dropped events: 2507 ```
|
@bobrik FYI, you generally don't need to force push new changes to your PRs. We merge pull requests by squashing, so individual work-in-progress commits to a branch are fine. See https://github.com/tokio-rs/console/blob/main/CONTRIBUTING.md#commit-squashing for details. |
|
@bobrik quick ping --- are you still planning to work on this? I'd like to get it merged! If you don't have the time to finish this, I'd be happy to wrap it up myself, just let me know! |
Before: ``` connection: http://127.0.0.1:6669/ (CONNECTED) dropped events: 2507 ``` After: ``` connection: http://127.0.0.1:6669/ (CONNECTED) dropped async_ops_state: 29172 dropped tasks_state: 72328 dropped resources_state: 240995304 ```
The numbers are much more reasonable this way. Before: ``` connection: http://127.0.0.1:6669/ (CONNECTED) dropped async_ops_state: 29172 dropped tasks_state: 72328 dropped resources_state: 240995304 ``` After: ``` connection: http://127.0.0.1:6669/ (CONNECTED) dropped async_ops_state: 76 dropped tasks_state: 3388 dropped resources_state: 28956 ```
|
Apologies for the delay. I pushed separate counters and a bugfix for overcounting of |
tokio-console/src/main.rs
Outdated
| let dropped_async_ops_state = state.async_ops_state().dropped_events(); | ||
| if dropped_async_ops_state > 0 { | ||
| header_text.0.push(Span::styled( | ||
| format!(" dropped async_ops_state: {}", dropped_async_ops_state), | ||
| view.styles.fg(Color::Red), | ||
| )); | ||
| } | ||
| let dropped_tasks_state = state.tasks_state().dropped_events(); | ||
| if dropped_tasks_state > 0 { | ||
| header_text.0.push(Span::styled( | ||
| format!(" dropped tasks_state: {}", dropped_tasks_state), | ||
| view.styles.fg(Color::Red), | ||
| )); | ||
| } | ||
| let dropped_resources_state = state.resources_state().dropped_events(); | ||
| if dropped_resources_state > 0 { | ||
| header_text.0.push(Span::styled( | ||
| format!(" dropped resources_state: {}", dropped_resources_state), | ||
| view.styles.fg(Color::Red), | ||
| )); | ||
| } |
There was a problem hiding this comment.
take it or leave it: we could probably save a little horizontal real estate by formatting the text like
dropped XXXX tasks, YYYY resources, ZZZZ async ops
or something?
instead of repeating the word "dropped" three times, we could check if any counter is non-zero, print a single "dropped", and then print the actual counts. not a blocker, though, as the current code should fit on most terminals.
Co-authored-by: Eliza Weisman <eliza@buoyant.io>
Before: ``` connection: http://127.0.0.1:6669/ (CONNECTED) dropped async_ops_state: 76 dropped tasks_state: 3388 dropped resources_state: 28956 ``` After: ``` connection: http://127.0.0.1:6669/ (CONNECTED) dropped: 48 async_ops, 2073 tasks, 17852 resources ```
<a name="0.1.4"></a> ## 0.1.4 (2022-04-13) #### Features * add autogenerated example config file to docs (#327) ([79da280](79da280)) * add `gen-config` subcommand to generate a config file (#324) ([e034f8d](e034f8d)) * surface dropped event count if there are any (#316) ([16df5d3](16df5d3)) * read configuration options from a config file (#320) ([defe346](defe346), closes [#310](310))
<a name="0.1.4"></a> ## 0.1.4 (2022-04-13) #### Features * add autogenerated example config file to docs (#327) ([79da280](79da280)) * add `gen-config` subcommand to generate a config file (#324) ([e034f8d](e034f8d)) * surface dropped event count if there are any (#316) ([16df5d3](16df5d3)) * read configuration options from a config file (#320) ([defe346](defe346), closes [#310](310))
During normal operation it won't show anything:
But if there are any drops detected, it will show a cumulative amount: