feat: add the WatchState API #582

0xPoe · 2024-09-05T14:06:32Z

close #551
close #567

This pull request introduces a new stream API named "WatchState." Currently, it only provides the current temporality, which will enable clients to check if the server has been paused.

See more: #567 (comment)

Screen.Recording.2024-10-26.at.17.18.50.mov

0xPoe · 2024-09-05T14:10:58Z

@hds Do you have time to take a quick look at this pull request before I continue? I want to ensure I'm on the right track and understand your feedback correctly.

Do you have any thoughts on how to use it with tokio-console? Currently, we use next_update to connect to the server and handle all the backoff stuff. I'm not sure how to use this new API in tokio-console. I'm unsure which step we should take first when we're trying to start the client. Perhaps we should watch the stats first? Or should we only watch the stats after we receive the first update?

hds · 2024-09-10T09:16:28Z

@Rustin170506 I think this is the right approach.

To integrate this with Tokio-Console, I would get the State stream from WatchState and include it in the tokio::select! statement in main():

console/tokio-console/src/main.rs

Line 81 in f8e1bee

tokio::select! { biased;

To make the UI "reactive" even in the event of network slow down, we may want to have some additional states in Tokio Console for "pausing" and "unpausing" which would be set in between the user pressing the space bar and the new state being received from the State stream.

Does that make sense?

0xPoe · 2024-09-12T13:59:16Z

To integrate this with Tokio-Console, I would get the State stream from WatchState and include it in the tokio::select! statement in main():

The issue at hand is that when we call next_event, it attempts to connect to the server within the function. However, since we've introduced a new API, we're unsure about when we should monitor this new API. Should we have next_event establish the connection first, or should we update the logic to monitor the state API and establish the connection simultaneously?

hds · 2024-09-12T20:01:06Z

My thought was to do it all simultaneously.

0xPoe

🔢 Self-check (PR reviewed by myself and ready for feedback.)

0xPoe · 2024-10-26T09:21:23Z

@hds, I finally have some time to fix it. Could you please take a look? Thank you!

hds

Everything is looking great!

I've got one suggestion regarding the user experience and a question regarding cancel safety.

tokio-console/src/state/mod.rs

tokio-console/src/conn.rs

0xPoe

🔢 Self-check (PR reviewed by myself and ready for feedback.)

hds

Looks great. Thank you!

Signed-off-by: Rustin170506 <[email protected]>

0xPoe · 2024-11-05T01:11:03Z

Rebaed to the latest master.

0xPoe · 2024-11-05T03:18:57Z

Thanks for your review! 💚 💙 💜 💛 ❤️

…onsole-v0.1.14 # console-api ## 0.9.0 - (2025-10-29) ### <a id = "0.9.0-breaking"></a>Breaking Changes - **Upgrade tonic to 0.13 ([#615](#615 ([2bd1afd](https://github.com/tokio-rs/console/commit/2bd1afda7987dea0505d231d9ce8bf109e5f7a96)) This is a breaking change for users of `console-api` and `console-subscriber`, as it changes the public `tonic` dependency to a semver-incompatible version. This breaks compatibility with `tonic` 0.12.x. - **Upgrade tonic to 0.14 ([#642](https://github.com/tokio-rs/console/issues/642))** This is a breaking change for users of `console-api` and `console-subscriber`, as it changes the public `tonic` dependency to a semver-incompatible version. This breaks compatibility with `tonic` 0.13.x. ### Added - Add the WatchState API ([#582](#582)) ([7c1f9f2](7c1f9f2)) ### Fixed - Bump minimum version of tonic ([#593](#593)) ([1f41b61](1f41b61), closes [#592](#592), closes [#592](#592)) ### Updated - [**breaking**](#0.9.0-breaking) Upgrade tonic to 0.13 ([#615](#615)) ([2bd1afd](2bd1afd)) - [**breaking**](#0.9.0-breaking) Upgrade tonic to 0.14 ([#645](#645)) # console-subscriber ## 0.5.0 - (2025-10-29) ### <a id = "0.5.0-breaking"></a>Breaking Changes - **Upgrade tonic to 0.13 ([#615](#615 ([2bd1afd](https://github.com/tokio-rs/console/commit/2bd1afda7987dea0505d231d9ce8bf109e5f7a96)) This is a breaking change for users of `console-api` and `console-subscriber`, as it changes the public `tonic` dependency to a semver-incompatible version. This breaks compatibility with `tonic` 0.12.x. - **Upgrade tonic to 0.14 ([#642](https://github.com/tokio-rs/console/issues/642))** This is a breaking change for users of `console-api` and `console-subscriber`, as it changes the public `tonic` dependency to a semver-incompatible version. This breaks compatibility with `tonic` 0.13.x. ### Added - Add the WatchState API ([#582](#582)) ([7c1f9f2](7c1f9f2)) - Add support for vsock connections ([#623](#623)) ([63c70ee](63c70ee)) ### Documented - Fix typo in doc comment ([3dbca7a](3dbca7a)) ### Updated - [**breaking**](#0.5.0-breaking) Upgrade tonic to 0.13 ([#615](#615)) ([2bd1afd](2bd1afd)) - [**breaking**](#0.9.0-breaking) Upgrade tonic to 0.14 ([#645](#645)) # tokio-console ## 0.1.14 - (2025-10-29) ### Added - Add the WatchState API ([#582](#582)) ([7c1f9f2](7c1f9f2)) - Improve error msg when state streaming API is unimplemented ([#598](#598)) ([6ef148a](6ef148a)) - Add support for vsock connections ([#623](#623)) ([63c70ee](63c70ee)) ### Fixed - Add dynamic constraints layout in task details screen ([#614](#614)) ([ada7dab](ada7dab), fixes [#523](#523), fixes [#523](#523)) ### Updated - Upgrade tonic to 0.13 ([#615](#615)) ([2bd1afd](2bd1afd)) - Upgrade tonic to 0.14 ([#645](#645))

…onsole-v0.1.14 # console-api ## 0.9.0 - (2025-10-30) ### <a id = "0.9.0-breaking"></a>Breaking Changes - **Upgrade tonic to 0.13 ([#615](#615 ([2bd1afd](https://github.com/tokio-rs/console/commit/2bd1afda7987dea0505d231d9ce8bf109e5f7a96)) This is a breaking change for users of `console-api` and `console-subscriber`, as it changes the public `tonic` dependency to a semver-incompatible version. This breaks compatibility with `tonic` 0.12.x. - **Upgrade tonic to 0.14 ([#642](https://github.com/tokio-rs/console/issues/642))** This is a breaking change for users of `console-api` and `console-subscriber`, as it changes the public `tonic` dependency to a semver-incompatible version. This breaks compatibility with `tonic` 0.13.x. ### Added - Add the WatchState API ([#582](#582)) ([7c1f9f2](7c1f9f2)) ### Fixed - Bump minimum version of tonic ([#593](#593)) ([1f41b61](1f41b61), closes [#592](#592), closes [#592](#592)) ### Updated - [**breaking**](#0.9.0-breaking) Upgrade tonic to 0.13 ([#615](#615)) ([2bd1afd](2bd1afd)) - [**breaking**](#0.9.0-breaking) Upgrade tonic to 0.14 ([#645](#645)) # console-subscriber ## 0.5.0 - (2025-10-30) ### <a id = "0.5.0-breaking"></a>Breaking Changes - **Upgrade tonic to 0.13 ([#615](#615 ([2bd1afd](https://github.com/tokio-rs/console/commit/2bd1afda7987dea0505d231d9ce8bf109e5f7a96)) This is a breaking change for users of `console-api` and `console-subscriber`, as it changes the public `tonic` dependency to a semver-incompatible version. This breaks compatibility with `tonic` 0.12.x. - **Upgrade tonic to 0.14 ([#642](https://github.com/tokio-rs/console/issues/642))** This is a breaking change for users of `console-api` and `console-subscriber`, as it changes the public `tonic` dependency to a semver-incompatible version. This breaks compatibility with `tonic` 0.13.x. ### Added - Add the WatchState API ([#582](#582)) ([7c1f9f2](7c1f9f2)) - Add support for vsock connections ([#623](#623)) ([63c70ee](63c70ee)) ### Documented - Fix typo in doc comment ([3dbca7a](3dbca7a)) ### Updated - [**breaking**](#0.5.0-breaking) Upgrade tonic to 0.13 ([#615](#615)) ([2bd1afd](2bd1afd)) - [**breaking**](#0.9.0-breaking) Upgrade tonic to 0.14 ([#645](#645)) # tokio-console ## 0.1.14 - (2025-10-30) ### Added - Add the WatchState API ([#582](#582)) ([7c1f9f2](7c1f9f2)) - Improve error msg when state streaming API is unimplemented ([#598](#598)) ([6ef148a](6ef148a)) - Add support for vsock connections ([#623](#623)) ([63c70ee](63c70ee)) ### Fixed - Add dynamic constraints layout in task details screen ([#614](#614)) ([ada7dab](ada7dab), fixes [#523](#523), fixes [#523](#523)) ### Updated - Upgrade tonic to 0.13 ([#615](#615)) ([2bd1afd](2bd1afd)) - Upgrade tonic to 0.14 ([#645](#645))

…onsole-v0.1.14 (#648) # console-api ## 0.9.0 - (2025-10-30) ### <a id = "0.9.0-breaking"></a>Breaking Changes - **Upgrade tonic to 0.13 ([#615](#615 ([2bd1afd](https://github.com/tokio-rs/console/commit/2bd1afda7987dea0505d231d9ce8bf109e5f7a96)) This is a breaking change for users of `console-api` and `console-subscriber`, as it changes the public `tonic` dependency to a semver-incompatible version. This breaks compatibility with `tonic` 0.12.x. - **Upgrade tonic to 0.14 ([#642](https://github.com/tokio-rs/console/issues/642))** This is a breaking change for users of `console-api` and `console-subscriber`, as it changes the public `tonic` dependency to a semver-incompatible version. This breaks compatibility with `tonic` 0.13.x. ### Added - Add the WatchState API ([#582](#582)) ([7c1f9f2](7c1f9f2)) ### Fixed - Bump minimum version of tonic ([#593](#593)) ([1f41b61](1f41b61), closes [#592](#592), closes [#592](#592)) ### Updated - [**breaking**](#0.9.0-breaking) Upgrade tonic to 0.13 ([#615](#615)) ([2bd1afd](2bd1afd)) - [**breaking**](#0.9.0-breaking) Upgrade tonic to 0.14 ([#645](#645)) # console-subscriber ## 0.5.0 - (2025-10-30) ### <a id = "0.5.0-breaking"></a>Breaking Changes - **Upgrade tonic to 0.13 ([#615](#615 ([2bd1afd](https://github.com/tokio-rs/console/commit/2bd1afda7987dea0505d231d9ce8bf109e5f7a96)) This is a breaking change for users of `console-api` and `console-subscriber`, as it changes the public `tonic` dependency to a semver-incompatible version. This breaks compatibility with `tonic` 0.12.x. - **Upgrade tonic to 0.14 ([#642](https://github.com/tokio-rs/console/issues/642))** This is a breaking change for users of `console-api` and `console-subscriber`, as it changes the public `tonic` dependency to a semver-incompatible version. This breaks compatibility with `tonic` 0.13.x. ### Added - Add the WatchState API ([#582](#582)) ([7c1f9f2](7c1f9f2)) - Add support for vsock connections ([#623](#623)) ([63c70ee](63c70ee)) ### Documented - Fix typo in doc comment ([3dbca7a](3dbca7a)) ### Updated - [**breaking**](#0.5.0-breaking) Upgrade tonic to 0.13 ([#615](#615)) ([2bd1afd](2bd1afd)) - [**breaking**](#0.9.0-breaking) Upgrade tonic to 0.14 ([#645](#645)) # tokio-console ## 0.1.14 - (2025-10-30) ### Added - Add the WatchState API ([#582](#582)) ([7c1f9f2](7c1f9f2)) - Improve error msg when state streaming API is unimplemented ([#598](#598)) ([6ef148a](6ef148a)) - Add support for vsock connections ([#623](#623)) ([63c70ee](63c70ee)) ### Fixed - Add dynamic constraints layout in task details screen ([#614](#614)) ([ada7dab](ada7dab), fixes [#523](#523), fixes [#523](#523)) ### Updated - Upgrade tonic to 0.13 ([#615](#615)) ([2bd1afd](2bd1afd)) - Upgrade tonic to 0.14 ([#645](#645)) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

0xPoe force-pushed the rustin-patch-temporality branch from dff938a to ce6331a Compare October 24, 2024 14:26

0xPoe marked this pull request as ready for review October 24, 2024 14:47

0xPoe requested a review from a team as a code owner October 24, 2024 14:47

0xPoe marked this pull request as draft October 24, 2024 15:12

0xPoe force-pushed the rustin-patch-temporality branch from 29263be to b7e65ce Compare October 26, 2024 09:15

0xPoe commented Oct 26, 2024

View reviewed changes

0xPoe marked this pull request as ready for review October 26, 2024 09:20

0xPoe requested a review from hds October 26, 2024 09:20

hds requested changes Oct 31, 2024

View reviewed changes

tokio-console/src/state/mod.rs Show resolved Hide resolved

tokio-console/src/conn.rs Show resolved Hide resolved

0xPoe commented Nov 2, 2024

View reviewed changes

0xPoe requested a review from hds November 2, 2024 06:41

hds approved these changes Nov 4, 2024

View reviewed changes

0xPoe added 11 commits November 5, 2024 09:10

feat: add the WatchState API

a72dd9a

Signed-off-by: Rustin170506 <[email protected]>

feat: implement watch_state

a823953

Signed-off-by: Rustin170506 <[email protected]>

feat: add next_message

6a3bf24

fix: update the generated files

d6c6e88

Signed-off-by: Rustin170506 <[email protected]>

fix: make clippy happy

a734fb4

Signed-off-by: Rustin170506 <[email protected]>

fix: update the generated files

d37e115

Signed-off-by: Rustin170506 <[email protected]>

refactor: biased select

1b2cd2b

Signed-off-by: Rustin170506 <[email protected]>

fix: remove useless blank line

3855f47

Signed-off-by: Rustin170506 <[email protected]>

fix: publish the stats correctly

deabe97

Signed-off-by: Rustin170506 <[email protected]>

fix: revert the comment

efe9bbe

Signed-off-by: Rustin170506 <[email protected]>

feat: add pausing and unpausing states

aa85882

Signed-off-by: Rustin170506 <[email protected]>

0xPoe force-pushed the rustin-patch-temporality branch from 71269d4 to aa85882 Compare November 5, 2024 01:10

0xPoe merged commit 7c1f9f2 into tokio-rs:main Nov 5, 2024
18 checks passed

github-actions bot mentioned this pull request Nov 5, 2024

chore: release #595

Closed

0xPoe deleted the rustin-patch-temporality branch November 9, 2024 09:23

github-actions bot mentioned this pull request Jul 2, 2024

chore: release ShabbirHasan1/console#1

Open

github-actions bot mentioned this pull request Oct 30, 2025

chore: release console-api-v0.9.0, console-subscriber-v0.5.0, tokio-console-v0.1.14 #648

Merged

Uh oh!

feat: add the WatchState API #582

feat: add the WatchState API #582

Uh oh!

Conversation

0xPoe commented Sep 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

0xPoe commented Sep 5, 2024

Uh oh!

hds commented Sep 10, 2024

Uh oh!

0xPoe commented Sep 12, 2024

Uh oh!

hds commented Sep 12, 2024

Uh oh!

0xPoe left a comment

Choose a reason for hiding this comment

Uh oh!

0xPoe commented Oct 26, 2024

Uh oh!

hds left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

0xPoe left a comment

Choose a reason for hiding this comment

Uh oh!

hds left a comment

Choose a reason for hiding this comment

Uh oh!

0xPoe commented Nov 5, 2024

Uh oh!

Uh oh!

0xPoe commented Nov 5, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

0xPoe commented Sep 5, 2024 •

edited

Loading