Grafana UI improvements #83

yuntanghsu · 2022-07-25T22:57:07Z

Map FlowEndReason value from int to string
Add user-friendly names for columns used in tables
Remove mean value in throughput related table
Add a threshold for time-series diagram to prevent points from connecting when the gap of time is > 90s
Remove limit 50 in time series panel (as it will only show the first 50 data point)

Signed-off-by: Yun-Tang Hsu hsuy@vmware.com

Below are the updated screenshots related the changes in this PR:

flow-record-dashboard:

2. pod-to-pod-dashboard:

3. pod-to-service-dashboard:

4. pod-to-external-dashboard:

5. node-to-node-dashboard:

6. network-policy-dashboard:

heanlan

Thanks Yun-Tang for the PR

build/charts/theia/provisioning/dashboards/flow_records_dashboard.json

heanlan · 2022-07-27T21:20:53Z

build/charts/theia/provisioning/dashboards/networkpolicy_dashboard.json

@@ -1,647 +1,639 @@
 {


It seems like the entire file has been changed due to some JSON re-formatting, which makes it hard to tell which functionality code has been changed.

Could you help verify only the following two changes mentioned by the PR description were made to this file?

Remove mean value in throughput related table

Add a threshold for time-series diagram to prevent points from connecting when the gap of time is > 90s

Yes, there are 18 panels with these settings. So I removed 18 "means", "limit 50" and added 18 "spanNulls": 90000

heanlan · 2022-07-27T21:23:28Z

build/charts/theia/provisioning/dashboards/node_to_node_dashboard.json

-          "calcs": [
-            "mean"
-          ],
+          "calcs": [],


As we removed the "mean" metric from legend, we might need to regenerate new screenshots and replace those in the network-flowvisibility.md documentation. Could you send me the related new screenshots? I'll upload them to S3 bucket and give you back the links to put in the doc.

Agree, could you also attach some screenshots related to the UI changes in this PR? This will be very helpful for code review.

I've updated these screenshots in the description above. Please take a look to see if these photos are acceptable. Thanks.

heanlan · 2022-07-27T21:27:06Z

build/charts/theia/provisioning/dashboards/node_to_node_dashboard.json

            }
          },
-          "format": 2
+          "queryType": "sql",
+          "rawSql": "SELECT $__timeInterval(flowEndSeconds) as time, CONCAT(sourceNodeName, '->', destinationNodeName) as pair, SUM(throughput) as Node\nFROM flows_node_view\nWHERE sourceNodeName != '' AND destinationNodeName != ''\nAND sourcePodNamespace NOT IN ('kube-system', 'flow-visibility', 'flow-aggregator')\nAND destinationPodNamespace NOT IN ('kube-system', 'flow-visibility', 'flow-aggregator')\nAND $__timeFilter(time)\nGROUP BY time, pair\nORDER BY time\nLIMIT 50",


To follow up on our previous discussion, do we need to remove the limit 50 from the time-series panels?

Yes, I think we have to remove it. Otherwise, user might not be able to see the latest data.

heanlan · 2022-07-27T21:43:13Z

Try to collect more feedback and suggestions, especially for the column name renaming. They are used in the table view of flow_records_dashboard(shown below). Yun-Tang also had a very good summarization list here: #76 (comment)

Please help evaluate the column names from a user perspective. We are trying to make the names easier to understand for users who might not have enough pre-knowledge on Antrea specific terminologies.

@yanjunz97 @dreamtalen @wsquan171 @salv-orlando @ziyouw

heanlan · 2022-07-28T20:28:06Z

By the way, do we also want to include the star all the dashboards by default in this PR?

codecov-commenter · 2022-07-29T22:23:00Z

Codecov Report

❗ No coverage uploaded for pull request base (main@4b15e06). Click here to learn what that means.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main      #83   +/-   ##
=======================================
  Coverage        ?   24.72%           
=======================================
  Files           ?        9           
  Lines           ?     1278           
  Branches        ?        0           
=======================================
  Hits            ?      316           
  Misses          ?      940           
  Partials        ?       22

Flag	Coverage Δ
unit-tests	`24.72% <0.00%> (?)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4b15e06...a1430a4. Read the comment docs.

dreamtalen · 2022-08-01T21:59:38Z

#76 (comment)

The new column names overall LGTM. Just have one suggestion for database insertion time, to keep consistent with other columns like start time of flow, how about changing it to insert time of flow or time of insertion of flow?

1. Map FlowEndReason value from int to string 2. Add user-friendly names for columns used in tables 3. Remove mean value in throughput related table 4. Add a threshold for time-series diagram to prevent points from connecting when the gap of time is > 90s Signed-off-by: Yun-Tang Hsu <hsuy@vmware.com>

yuntanghsu · 2022-08-03T18:18:29Z

/theia-test-e2e

dreamtalen · 2022-08-04T17:19:35Z

LGTM

yuntanghsu requested a review from heanlan July 25, 2022 22:58

yuntanghsu added this to the 0.2 milestone Jul 25, 2022

yuntanghsu added the enhancement New feature or request label Jul 25, 2022

yuntanghsu force-pushed the grafana_ui_improvement branch from 8b89a00 to 7155d2b Compare July 25, 2022 23:01

yuntanghsu removed the enhancement New feature or request label Jul 25, 2022

This was linked to issues Jul 25, 2022

App Visibility Grafana dashboard enhancement #58

Closed

User-friendly names for flow record fields in Grafana dashboard #76

Closed

yuntanghsu force-pushed the grafana_ui_improvement branch 2 times, most recently from 7fa03ec to e24117c Compare July 26, 2022 00:25

heanlan reviewed Jul 27, 2022

View reviewed changes

yuntanghsu force-pushed the grafana_ui_improvement branch 2 times, most recently from 8bca2e5 to 46a5a97 Compare July 29, 2022 22:22

yuntanghsu force-pushed the grafana_ui_improvement branch from 46a5a97 to a1430a4 Compare July 29, 2022 22:31

yuntanghsu force-pushed the grafana_ui_improvement branch from a1430a4 to 0a204b0 Compare August 2, 2022 16:57

yuntanghsu force-pushed the grafana_ui_improvement branch from 0a204b0 to aa6b7bb Compare August 3, 2022 17:29

heanlan approved these changes Aug 3, 2022

View reviewed changes

yuntanghsu requested a review from dreamtalen August 4, 2022 17:11

yuntanghsu merged commit 3e15d4e into antrea-io:main Aug 4, 2022

yuntanghsu deleted the grafana_ui_improvement branch August 4, 2022 17:22

heanlan mentioned this pull request Aug 17, 2022

App Visibility Grafana dashboard enhancement #58

Closed

8 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Grafana UI improvements #83

Grafana UI improvements #83

yuntanghsu commented Jul 25, 2022 •

edited

heanlan left a comment

heanlan Jul 27, 2022 •

edited

yuntanghsu Jul 29, 2022

heanlan Jul 27, 2022

dreamtalen Aug 2, 2022

yuntanghsu Aug 2, 2022

heanlan Jul 27, 2022

yuntanghsu Jul 29, 2022

heanlan commented Jul 27, 2022 •

edited

heanlan commented Jul 28, 2022

codecov-commenter commented Jul 29, 2022 •

edited

dreamtalen commented Aug 1, 2022

yuntanghsu commented Aug 3, 2022

dreamtalen commented Aug 4, 2022

Grafana UI improvements #83

Grafana UI improvements #83

Conversation

yuntanghsu commented Jul 25, 2022 • edited

heanlan left a comment

Choose a reason for hiding this comment

heanlan Jul 27, 2022 • edited

Choose a reason for hiding this comment

yuntanghsu Jul 29, 2022

Choose a reason for hiding this comment

heanlan Jul 27, 2022

Choose a reason for hiding this comment

dreamtalen Aug 2, 2022

Choose a reason for hiding this comment

yuntanghsu Aug 2, 2022

Choose a reason for hiding this comment

heanlan Jul 27, 2022

Choose a reason for hiding this comment

yuntanghsu Jul 29, 2022

Choose a reason for hiding this comment

heanlan commented Jul 27, 2022 • edited

heanlan commented Jul 28, 2022

codecov-commenter commented Jul 29, 2022 • edited

Codecov Report

dreamtalen commented Aug 1, 2022

yuntanghsu commented Aug 3, 2022

dreamtalen commented Aug 4, 2022

yuntanghsu commented Jul 25, 2022 •

edited

heanlan Jul 27, 2022 •

edited

heanlan commented Jul 27, 2022 •

edited

codecov-commenter commented Jul 29, 2022 •

edited