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

chore(dashboards): Updating grafana dashboards and adding them to Grafana Portal #1285

Open
wants to merge 44 commits into
base: main
Choose a base branch
from

Conversation

apontejaj
Copy link
Contributor

@apontejaj apontejaj commented Jan 30, 2025

Description

This PR cover multiple aspects regarding Grafana Dashboards.

  • It updates the Grafana dashboards for the Retina project and adds them to the Grafana Portal.
  • Retina Dashboards and JSON files have been renamed to reflect which ones are meant to work with Standard or Hubble control plane, as well as control plane agnostic.
  • All files have been moved to a new common folder deploy/grafana-dashboards/
  • New workflow has been added to test dashboards have a simplified structure.
  • Simplified dashboard test has been modified to fail in case the folder structure is changed in the future.
  • Documentation has been updated.

Related Issue

pods and dns dashboards are not part of the published Grafana dashboards #178

Screenshots (if applicable) or Testing Completed

Only names are changed on the dashboards. Layouts and queries remain the same.

image

image

image

image

image

Checklist

  • I have read the contributing documentation.
  • I signed and signed-off the commits (git commit -S -s ...). See this documentation on signing commits.
  • I have correctly attributed the author(s) of the code.
  • I have tested the changes locally.
  • I have followed the project's style guidelines.
  • I have updated the documentation, if necessary.
  • I have added tests, if applicable.

Additional Notes

New Retina Grafana account has been created as part of this PR.
Also, the scope has been extended to cover dashboards for Hubble control plane which was not mentioned in the original issue.


Please refer to the CONTRIBUTING.md file for more information on how to contribute to this project.

@apontejaj apontejaj requested a review from a team as a code owner January 30, 2025 09:59
Copy link
Member

@SRodi SRodi left a comment

Choose a reason for hiding this comment

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

Can you add a couple of screenshots for each Grafana dashboards in the PR description? This can serve as a test for this PR.

@apontejaj
Copy link
Contributor Author

Can you add a couple of screenshots for each Grafana dashboards in the PR description? This can serve as a test for this PR.

Added.
The only changes on the dashboards were on their name. Layouts and queries remain the same.

@apontejaj
Copy link
Contributor Author

apontejaj commented Feb 5, 2025

I can't see traffic on Pod-Traffic dashboards, but that would be a separate issue..

Copy link
Contributor

@huntergregory huntergregory left a comment

Choose a reason for hiding this comment

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

We should remove/replace this in dashboards:

"content": "# Network Observability Metrics\n\nUse this dashboard to visualise metrics from the Network Observability add-on for AKS. Dashboard displays metrics from Linux and Windows Clusters. To hide the irrelevant metrics, simply collapse the unwanted sections. Alternatively, you can edit the dashboard to delete unwanted panels. For any questions or issues, please see our documentation.",

SRodi
SRodi previously approved these changes Feb 5, 2025
Copy link
Member

@SRodi SRodi left a comment

Choose a reason for hiding this comment

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

LGTM, pending review from @huntergregory

@apontejaj
Copy link
Contributor Author

apontejaj commented Feb 5, 2025

We should remove/replace this in dashboards:

"content": "# Network Observability Metrics\n\nUse this dashboard to visualise metrics from the Network Observability add-on for AKS. Dashboard displays metrics from Linux and Windows Clusters. To hide the irrelevant metrics, simply collapse the unwanted sections. Alternatively, you can edit the dashboard to delete unwanted panels. For any questions or issues, please see our documentation.",

Thanks @huntergregory
This has been addressed in latest commit.

Copy link
Contributor

@huntergregory huntergregory left a comment

Choose a reason for hiding this comment

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

Can we remove any other mentions of AKS / netobs addon? For instance, the documentation link ought to point to retina

@apontejaj
Copy link
Contributor Author

Can we remove any other mentions of AKS / netobs addon? For instance, the documentation link ought to point to retina

I'm pretty sure I have covered this. But I'll do another search everywhere to make sure I didn't miss anything.

@apontejaj
Copy link
Contributor Author

apontejaj commented Feb 6, 2025

Can we remove any other mentions of AKS / netobs addon? For instance, the documentation link ought to point to retina

I'm pretty sure I have covered this. But I'll do another search everywhere to make sure I didn't miss anything.

All mentions to network observability (names, tags and documentation) have been updated to point to Retina in the last commit.

deploy/hubble/grafana/dashboards/dns.json Outdated Show resolved Hide resolved
docs/02-Installation/05-grafana.md Show resolved Hide resolved
deploy/hubble/grafana/dashboards/clusters.json Outdated Show resolved Hide resolved
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