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

Add examples folder for alerts & dashboards, and observability stack #461

Merged

Conversation

david-martin
Copy link
Member

@david-martin david-martin commented Mar 13, 2024

Part of #448

There are separate issues to update these dashboards, add new ones and add example alerts, all tracked in #439

There's a separate PR for how these dashboards will be included as part of the release process.
Kuadrant/architecture#85

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 in the PR to deploy the stack and access grafana or prometheus.

You can also import the example dashboards 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.

@david-martin david-martin requested a review from a team as a code owner March 13, 2024 11:17
Copy link

codecov bot commented Mar 13, 2024

Codecov Report

Merging #461 (fa9976c) into main (e51ddaf) will decrease coverage by 51.27%.
The diff coverage is n/a.

Additional details and impacted files
@@             Coverage Diff             @@
##             main     #461       +/-   ##
===========================================
- Coverage   81.30%   30.03%   -51.27%     
===========================================
  Files          64       58        -6     
  Lines        4492     4132      -360     
===========================================
- Hits         3652     1241     -2411     
- Misses        567     2822     +2255     
+ Partials      273       69      -204     
Flag Coverage Δ
integration ?
unit 30.03% <ø> (ø)

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

Components Coverage Δ
api/v1beta1 (u) ∅ <ø> (∅)
api/v1beta2 (u) 50.71% <ø> (-40.72%) ⬇️
pkg/common (u) 87.70% <ø> (-1.12%) ⬇️
pkg/istio (u) 41.61% <ø> (-33.55%) ⬇️
pkg/log (u) 36.84% <ø> (-57.90%) ⬇️
pkg/reconcilers (u) 38.20% <ø> (-28.09%) ⬇️
pkg/rlptools (u) 56.40% <ø> (-23.06%) ⬇️
controllers (i) 8.09% <ø> (-70.45%) ⬇️

see 46 files with indirect coverage changes

@david-martin david-martin force-pushed the add-example-dashboards-and-alerts branch from f5a1e54 to fa9976c Compare March 13, 2024 11:27
@david-martin david-martin changed the title Add examples folder for alerts & dashboards, with initial 2 dashboards Add examples folder for alerts & dashboards, and observability stack Mar 14, 2024
@david-martin david-martin force-pushed the add-example-dashboards-and-alerts branch from d86ac56 to ffe7ae5 Compare March 14, 2024 17:11
@R-Lawton
Copy link
Contributor

👀

@R-Lawton
Copy link
Contributor

Feedback on Dashboards:
app-developer:
The table should use center it looks cleaner and fit screens better

platform:

  • Im thinking the single stat values could be a little bit bigger i don't see the table needing as much space as it has

  • Gateway table is all squshed into the corner would be better to have even spaced and in the center

Screenshot 2024-03-19 at 15 13 46

  • Space out table columns evenly and center them
    Screenshot 2024-03-19 at 15 16 00

  • Center the apis table columns

@david-martin
Copy link
Member Author

Feedback on Dashboards

Thanks for the feedback on the dashboards.
While this PR is moreso getting the examples in place and a process for developing dashboards, those notes should be helpful for the follow up issues #434 and #435 (the former which has a PR already #494).
I'll leave any modifications to the dashboards out of this PR so that it can land earlier and we'll have the process in place for updating as needed then.

@R-Lawton
Copy link
Contributor

R-Lawton commented Mar 19, 2024

ah ok deadly if its just to get things up and running, it does what it says on the tin monitoring pods are up

@david-martin david-martin force-pushed the add-example-dashboards-and-alerts branch 2 times, most recently from b833029 to 4d862a4 Compare March 20, 2024 11:58
@david-martin david-martin force-pushed the add-example-dashboards-and-alerts branch from 4d862a4 to 4fe51c6 Compare March 20, 2024 11:59
@david-martin
Copy link
Member Author

@R-Lawton I've pushed up the recommended changes.
The link to the examples folder works locally in vscode, but not in the preview. I think it should work when back on main rather than viewing it in the PR rich diff view.

Copy link
Member

@jasonmadigan jasonmadigan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

config/observability/README.md Show resolved Hide resolved
@david-martin david-martin merged commit b42adda into Kuadrant:main Mar 21, 2024
13 checks passed
@david-martin david-martin deleted the add-example-dashboards-and-alerts branch March 21, 2024 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants