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

rpk: Wire Grafana dashboard generation to Github #9662

Merged
merged 4 commits into from
Mar 28, 2023

Conversation

r-vasquez
Copy link
Contributor

@r-vasquez r-vasquez commented Mar 24, 2023

Now rpk will try to download the dashboards from our Observability repo, if something fails, then it will fall back to the old way of generating the dashboard.

This is the first step towards solving #6502, next step is to fall back to embedded static files.

The user can use the bash auto-completion features ([shift] [shift]) to get the available dashboards, or use the --dashboard help option:

image

Backports Required

  • none - not a bug fix

Release Notes

Features

Now rpk will try to download the dashboards from
our Observability repo, if something fails, then
it will fallback to the old way of generating the
dashboard
@emaxerrno
Copy link
Contributor

@r-vasquez - should rpk have a 'default' string in case github is unreachable. i.e.: just as part of rpk

@emaxerrno
Copy link
Contributor

given that we have /public_metrics endpoint, and that's now stable, i think a static string could be fine too as a fallback.

@emaxerrno
Copy link
Contributor

i guess caveat is that if rpk is old then .... so maybe w/ an additional flag

@r-vasquez
Copy link
Contributor Author

@emaxerrno I'm working on a new PR that will include default embedded static files for each dashboard in the case that GH query fails (or if it's an air-gapped environment).

I'll add a new flag to this PR to skip the download and go straight to the auto-generated dashboard.

in the case of GH unreachable or that you just
want the old autogenerated dashaboard then you
can use this flag.
gene-redpanda
gene-redpanda previously approved these changes Mar 27, 2023
And also have autocompletion for the --dashboard
flag.
@r-vasquez
Copy link
Contributor Author

Last commit includes the autocompletion for the --dashboard flag:

image

@r-vasquez r-vasquez merged commit b33b122 into redpanda-data:dev Mar 28, 2023
@r-vasquez r-vasquez deleted the wire-grafana-dashboard branch April 12, 2023 19:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants