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

Badge Request Grafana Dashboard Badge #10670

Open
czantoine opened this issue Nov 12, 2024 · 2 comments
Open

Badge Request Grafana Dashboard Badge #10670

czantoine opened this issue Nov 12, 2024 · 2 comments
Labels
service-badge New or updated service badge

Comments

@czantoine
Copy link

czantoine commented Nov 12, 2024

📋 Description

The feature request is for the addition of a Badge for Grafana Dashboard Metrics that displays detailed statistics about the dashboard's popularity, including its download count, revision, and usage data. These badges will be customizable with text and color and can optionally display a logo.

Service: Grafana Dashboard
Information Displayed: Download count of the Grafana dashboard, badge color based on popularity, and revision count.
Example: "Downloads | 1234" or "Revision | 5" as dynamic values.

🔗 Data

  • Public API: Grafana offers public API endpoints to retrieve dashboard information.
  • Authentication: The API does not require authentication for public dashboards
  • Data Source: The data is retrieved via scraping the Grafana dashboard pages, using the dashboard ID as a key.

🎤 Motivation

This feature will help users to display the popularity and version of their Grafana dashboards through easily accessible and customizable badges. By generating these badges, dashboard creators can share and visualize the success of their dashboards with others, creating more engagement in the community.

Use Case: Users want to show how popular their dashboards are (download count) or display the most recent version (revision). This would be used by dashboard creators to show the current download count of their Grafana dashboard in GitHub README files, blogs, or community forums.

I have already worked on this project with the Grafana Dashboard Badge repository, which allows generating badges to display these metrics in a simple way.

Download Badge

@czantoine czantoine added the service-badge New or updated service badge label Nov 12, 2024
@czantoine czantoine changed the title Badge Request Badge Request Grafana Dashboard Badge Nov 12, 2024
@chris48s
Copy link
Member

Example call that would give us this:

curl "https://grafana.com/api/dashboards/21378" | jq .downloads

Is there a way we can explain clearly in the docs exactly what this is. Like for example, I'd refer to https://metrics.shields.io/d/aESRBSjmz/services as "a Grafana dashboard" (possibly wrongly), but that isn't quite what we're talking about here.

Is there a phrase we can use (Grafana Cloud, Grafana Labs?) that more clearly explains: What is the thing we're displaying the number of downloads for here?

@jNullj
Copy link
Contributor

jNullj commented Nov 13, 2024

How about "Grafana Dashboard Template" or "Grafana Labs Dashboard Template"? (used here)
I'm not sure but it seems the cloud brand is more related to hosting instances while the dashboard templates are usable for both cloud and non cloud users.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
service-badge New or updated service badge
Projects
None yet
Development

No branches or pull requests

3 participants