badges / shields

Concise, consistent, and legible badges in SVG and raster format
https://shields.io
Creative Commons Zero v1.0 Universal
23.83k stars 5.51k forks source link

Badge Request Grafana Dashboard Badge #10670

Open czantoine opened 3 days ago

czantoine commented 3 days ago

📋 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

🎤 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

chris48s commented 1 day ago

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 commented 1 day ago

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.