[Dashboard] Enable customizable refresh frequency for the Metrics page #44037

liuxsh9 · 2024-03-15T07:41:24Z

Why are these changes needed?

Currently, each chart on the Metrics page is continuously refreshing, which can put strain on the network and frontend. In our application with @nemo9cby @Bye-legumes, we have noticed that during periods of unstable cluster networks, there can be instances of response timeouts or loss.

Therefore, having the ability to customize the refresh frequency would be helpful.

In the proposed modification, we have set the default refresh frequency to 1 second and provided various frequency configurations, following the example of Grafana. This way, users can choose the refresh interval that best suits their needs.

Related issue number

Checks

I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
I've run scripts/format.sh to lint the changes in this PR.
I've included any doc changes needed for https://docs.ray.io/en/master/.
- I've added any new APIs to the API Reference. For example, if I added a
  method in Tune, I've added it in doc/source/tune/api/ under the
  corresponding .rst file.
I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
Testing Strategy
- Unit tests
- Release tests
- This PR is not tested :(

Signed-off-by: liuxsh9 <liuxiaoshuang4@huawei.com>

Signed-off-by: Xiaoshuang Liu <liuxiaoshuang4@huawei.com>

alanwguo

Nice, thanks for adding this.

Can you also add this to the metrics section of the service page and the serve deployment page?

alanwguo · 2024-06-13T18:52:23Z

dashboard/client/src/pages/metrics/Metrics.tsx

@@ -377,6 +421,8 @@ export const Metrics = () => {
  const toParam = to !== null ? `&to=${to}` : "";
  const timeRangeParams = `${fromParam}${toParam}`;

+  const refreshParams = refresh !== "" ? `&refresh=${refresh}` : "";


Suggested change

const refreshParams = refresh !== "" ? `&refresh=${refresh}` : "";

const refreshParams = refresh ? `&refresh=${refresh}` : "";

Since refresh can also be null?

That's right, modified.

alanwguo · 2024-06-13T18:54:47Z

dashboard/client/src/pages/metrics/Metrics.tsx

@@ -358,13 +390,25 @@ export const Metrics = () => {

  const grafanaDefaultDatasource = dashboardDatasource ?? "Prometheus";

+  const [refreshOption, setRefreshOption] = useState<RefreshOptions>(
+    RefreshOptions.ONE_SECOND,


Can we make the default five seconds? one second seems too frequent.

Sure! Five seconds is also the frequency we prefer. I was worried that changing from continuous updates to five seconds would change the habits of historical users. Seems like an unnecessary worry.

Signed-off-by: liuxsh9 <liuxiaoshuang4@huawei.com>

liuxsh9 · 2024-06-14T08:23:39Z

Can you also add this to the metrics section of the service page and the serve deployment page?

Sure! Has also been added to the service and serve deployment page.

scottsun94 · 2024-06-14T21:24:52Z

@liuxsh9 can you add a short recording of how it looks like? (sorry, I'm not fluent at building the frontend and checking it out by myself. It will be easier for me to take a look at the recording)

alanwguo · 2024-06-14T21:54:46Z

can we make the buttons consistent styling? One is outlined and the other is underlined, can we do underlined for both?

While you're here, can you also expand the width of the "Last 5..." box so we can see the full text?

Signed-off-by: liuxsh9 <liuxiaoshuang4@huawei.com>

…text appears Signed-off-by: liuxsh9 <liuxiaoshuang4@huawei.com>

Signed-off-by: liuxsh9 <liuxiaoshuang4@huawei.com>

liuxsh9 · 2024-06-17T14:23:34Z

Great suggestion! How about this? @alanwguo @scottsun94

dashboard/client/src/pages/metrics/Metrics.tsx

scottsun94 · 2024-06-17T16:39:58Z

LGTM. Thanks!

Co-authored-by: Huaiwei Sun <scottsun94@gmail.com> Signed-off-by: Xiaoshuang Liu <liuxiaoshuang4@huawei.com>

Signed-off-by: liuxsh9 <liuxiaoshuang4@huawei.com>

liuxsh9 · 2024-06-18T03:58:52Z

Based on testing, the lowest available refresh rate was found to be 5 seconds, so the 1 second option was removed.

liuxsh9 · 2024-06-19T02:03:28Z

@alanwguo Hi alan, do you think this PR is ready to be merged?

scottsun94 · 2024-06-19T04:38:22Z

@alanwguo Hi alan, do you think this PR is ready to be merged?

@alanwguo is out until Thursday. Let's wait a little bit?

alanwguo

lgtm, thanks!

I'll have someone merge after tests pass

anyscalesam added triage Needs triage (eg: priority, bug/not-bug, and owning component) observability Issues related to the Ray Dashboard, Logging, Metrics, Tracing, and/or Profiling labels Apr 29, 2024

anyscalesam added the dashboard Issues specific to the Ray Dashboard label May 14, 2024

liuxsh9 added 2 commits June 12, 2024 10:09

Adding refresh rate feature to the metrics page.

3af77e7

Signed-off-by: liuxsh9 <liuxiaoshuang4@huawei.com>

Update Metrics code to resolve merge conflicts

71b4656

Signed-off-by: Xiaoshuang Liu <liuxiaoshuang4@huawei.com>

liuxsh9 force-pushed the dashboard_metrics_optimize branch from e050fcd to 71b4656 Compare June 12, 2024 02:10

anyscalesam requested a review from alanwguo June 13, 2024 01:20

alanwguo reviewed Jun 13, 2024

View reviewed changes

liuxsh9 added 3 commits June 14, 2024 15:42

Added custom refresh times to Metrix in Serve and Serve deployment page

7544a1d

Signed-off-by: liuxsh9 <liuxiaoshuang4@huawei.com>

Changed the default refresh time of metrics to 5 seconds

5ff2adb

Signed-off-by: liuxsh9 <liuxiaoshuang4@huawei.com>

Code optimization

4d33947

Signed-off-by: liuxsh9 <liuxiaoshuang4@huawei.com>

anyscalesam added enhancement Request for new feature and/or capability P2 Important issue, but not time-critical labels Jun 14, 2024

anyscalesam requested a review from alanwguo June 14, 2024 21:10

anyscalesam assigned alanwguo and scottsun94 Jun 14, 2024

anyscalesam requested a review from scottsun94 June 14, 2024 21:10

anyscalesam removed the triage Needs triage (eg: priority, bug/not-bug, and owning component) label Jun 14, 2024

liuxsh9 added 3 commits June 17, 2024 09:08

maintain a consistent element style

557573c

Signed-off-by: liuxsh9 <liuxiaoshuang4@huawei.com>

Use the underlined style and adjust the twist width so that the full …

2c87334

…text appears Signed-off-by: liuxsh9 <liuxiaoshuang4@huawei.com>

add help tip

2499321

Signed-off-by: liuxsh9 <liuxiaoshuang4@huawei.com>

scottsun94 reviewed Jun 17, 2024

View reviewed changes

dashboard/client/src/pages/metrics/Metrics.tsx Outdated Show resolved Hide resolved

liuxsh9 and others added 2 commits June 18, 2024 08:54

Update dashboard/client/src/pages/metrics/Metrics.tsx

0991687

Co-authored-by: Huaiwei Sun <scottsun94@gmail.com> Signed-off-by: Xiaoshuang Liu <liuxiaoshuang4@huawei.com>

remove one second option

1047973

Signed-off-by: liuxsh9 <liuxiaoshuang4@huawei.com>

alanwguo added the go add ONLY when ready to merge, run all tests label Jun 20, 2024

alanwguo approved these changes Jun 20, 2024

View reviewed changes

rkooo567 merged commit 52947d7 into ray-project:master Jun 20, 2024
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Dashboard] Enable customizable refresh frequency for the Metrics page #44037

[Dashboard] Enable customizable refresh frequency for the Metrics page #44037

liuxsh9 commented Mar 15, 2024

alanwguo left a comment

alanwguo Jun 13, 2024

liuxsh9 Jun 14, 2024

alanwguo Jun 13, 2024

liuxsh9 Jun 14, 2024

liuxsh9 commented Jun 14, 2024

scottsun94 commented Jun 14, 2024

alanwguo commented Jun 14, 2024 •

edited

Loading

liuxsh9 commented Jun 17, 2024

scottsun94 commented Jun 17, 2024

liuxsh9 commented Jun 18, 2024

liuxsh9 commented Jun 19, 2024

scottsun94 commented Jun 19, 2024

alanwguo left a comment

	const refreshParams = refresh !== "" ? `&refresh=${refresh}` : "";
	const refreshParams = refresh ? `&refresh=${refresh}` : "";

[Dashboard] Enable customizable refresh frequency for the Metrics page #44037

[Dashboard] Enable customizable refresh frequency for the Metrics page #44037

Conversation

liuxsh9 commented Mar 15, 2024

Why are these changes needed?

Related issue number

Checks

alanwguo left a comment

Choose a reason for hiding this comment

alanwguo Jun 13, 2024

Choose a reason for hiding this comment

liuxsh9 Jun 14, 2024

Choose a reason for hiding this comment

alanwguo Jun 13, 2024

Choose a reason for hiding this comment

liuxsh9 Jun 14, 2024

Choose a reason for hiding this comment

liuxsh9 commented Jun 14, 2024

scottsun94 commented Jun 14, 2024

alanwguo commented Jun 14, 2024 • edited Loading

liuxsh9 commented Jun 17, 2024

scottsun94 commented Jun 17, 2024

liuxsh9 commented Jun 18, 2024

liuxsh9 commented Jun 19, 2024

scottsun94 commented Jun 19, 2024

alanwguo left a comment

Choose a reason for hiding this comment

alanwguo commented Jun 14, 2024 •

edited

Loading