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

metrics: make it easier to update / discover Grafana dashboard #2055

Closed
marten-seemann opened this issue Feb 4, 2023 · 2 comments
Closed
Labels
effort/hours Estimated to take one or several hours exp/intermediate Prior experience is likely helpful kind/discussion Topical discussion; usually not changes to codebase

Comments

@marten-seemann
Copy link
Contributor

marten-seemann commented Feb 4, 2023

Currently all of our Grafana dashboards are available right next to the instrumented code.
They are:

We need to make it as easy as possible for our users to import all the dashboards. At the moment, we define 3 dashboards (swarm, rcmgr, eventbus), but with #1356, we'll soon have ~10 dashboards.

One option to simplify things a bit would be to create a single dashboards directory in the root directory that holds all dashboards. Users would still have to open every JSON file and copy-paste it into their Grafana instance, but at least they don't have to walk our directory tree.

Another option would be to evaluate the grafana.com import option:
image
Apparently you can import a dashboard by URL or by ID. Unfortunately, a URL pointing to a GitHub repository doesn't work, it has to be a grafana.com URL. Maybe there's an easy way to publish our dashboards on grafana.com via a GitHub Action when we cut a release?

@marten-seemann marten-seemann added help wanted Seeking public contribution on this issue kind/discussion Topical discussion; usually not changes to codebase exp/intermediate Prior experience is likely helpful effort/hours Estimated to take one or several hours labels Feb 4, 2023
@MarcoPolo
Copy link
Collaborator

We should also have a README in that directory.

@MarcoPolo MarcoPolo removed the help wanted Seeking public contribution on this issue label Jun 19, 2023
@MarcoPolo
Copy link
Collaborator

This is done with all dashboards in a single folder. We can't have a single one-click to import all the dashboards with what Grafana provides.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort/hours Estimated to take one or several hours exp/intermediate Prior experience is likely helpful kind/discussion Topical discussion; usually not changes to codebase
Projects
None yet
Development

No branches or pull requests

2 participants