Skip to content
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

Refine platform eng dashboard #494

Merged
merged 3 commits into from
Mar 22, 2024

Conversation

david-martin
Copy link
Member

Closes #434
Depends on #461

  • New panels to show network i/o, cpu & memory by API
  • Removed gatekeeper panels
  • Added tooltips for all panels
  • Added variables for namespace and httproute selection

Panels are grouped by 2 rows. Policies and APIs.

image

image

image

Deep links to the app developer dashboard will be added in #435

To verify this PR, the single cluster getting started guide can be followed https://docs.kuadrant.io/getting-started-single-cluster/
Then run the commands from the observability README from #461.

You can then import the example dashboard json into grafana.
For data to show up on the dashboards, you can follow the guide at https://docs.kuadrant.io/kuadrant-operator/doc/user-guides/secure-protect-connect/ to create various gateway api and kuadrant resources.

You will also need to add the deployment name as a label to the HTTPRoute for some panels to show data.
e.g. kubectl label httproute toystore -n default deployment=toystore
Some panels will only show data if traffic has been sent recently (may take up to 5 mins for some panels to show aggregated data). You can leave a curl loop running, like the guide above suggests.

@david-martin david-martin requested a review from a team as a code owner March 19, 2024 11:55
@R-Lawton
Copy link
Contributor

👀

@david-martin david-martin force-pushed the refine-platform-eng-dashboard branch from a6b6336 to b5969e0 Compare March 21, 2024 11:45
@david-martin
Copy link
Member Author

@R-Lawton I see you had some comments about this dashboard in #461 (comment).
The dashboard has changed from what you may have seen in that PR.
Would you mind reviewing and see if your feedback has been addressed sufficiently in this PR?
Thanks

@R-Lawton
Copy link
Contributor

Looking at the dashboard with the new changes one or two things I'm thinking:

I think making the single stat values a bit larger would be good. For the tool tips on those panels, I'm thinking if i was looking at that for the first time with little context i would be thinking what does accepted or programmed mean so a link to a doc or a quick tldr might be worth adding.

The tables are showing up a bit squashed to one corner of the tables themselves, setting the panels to centre rather then auto should solve that. I made some of the column widths a bit more uniform rather than some being wide and some being skinny.

I was thinking of making the API error graph the full length of the screen to rather then having a gap
Screenshot 2024-03-22 at 11 53 00
Screenshot 2024-03-22 at 11 53 07

@david-martin
Copy link
Member Author

@R-Lawton Thanks for the feedback.

I've widened the single stats and added links to the gateway api status condition type docs
image
image

The tables look much neater now with the centering and auto column width
image

For the API Error Rate graph, I'm not sure about changing that panel to be full width.
I kept the panels aligned below each other so they can more easily be compared for the same time range. For example, if you are seeing spikes on the API Traffic Summary graphs, you can move your view vertically down to the Error Rate panel and see if there's a correlation more easily.
I know that could be an argument for putting all 5 of the line chart panels aligned vertically, but my thinking there is most people would be viewing in a wide window, and the full width of the window for looks quite sparse.

All this being said, the goal here is to give a reasonable starting point or inspiration for people to go and build their own dashboards that give the most important information for them, so I won't get too hung up on it as long as it subjectively looks good.

@R-Lawton
Copy link
Contributor

no problemo, Looks really good, the tables look great, the only things is i think there might be overrides on the gateways table that are causing the big gaps and the centring to still look pushed to the side.

Ok yeah i see what your saying that makes sense to me. Yeah your right these are jumping off points for users

@david-martin
Copy link
Member Author

@R-Lawton you're right.
Fixed up the Gateways table now too
image

@R-Lawton
Copy link
Contributor

Looks great noice job
/lgtm

@R-Lawton R-Lawton merged commit da42a15 into Kuadrant:main Mar 22, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants