Detect dashboards depending on Angular data source and panel plugins on a running Grafana instance using the Grafana API.
Compatible with Grafana OSS, Grafana Enterprise, On-Prem and Grafana Cloud.
Read more about Angular support deprecation in our documentation.
The program requires a service account and API key to work properly.
Configuration changes slightly depending on your version of Grafana.
We recommend using Grafana >= 10.1.0, otherwise Angular private plugins (that are not in Grafana's catalog) won't be detected.
Create a service account with Viewer role.
Then, create a service account token for the newly created service account and set it to the GRAFANA_TOKEN env var.
Warning, Angular private plugins won't be detected from the scan when using Grafana <= 10.1.0.
Create a service account, with Plugins / Plugin Maintainer permissions (or "Admin" if using OSS without RBAC).
The reason behind admin rights is that the plugins endpoint returns all plugins only if the token can view and install plugins.
Then, create a service account token for the newly created service account and set it to the GRAFANA_TOKEN env var.
GRAFANA_TOKEN=glsa_aaaaaaaaaaa ./detect-angular-dashboards http://my-grafana.example.com/api
2023/08/17 11:17:12 Detecting Angular dashboards for "http://my-grafana.example.com/api"
2023/08/17 11:17:13 Found dashboard with Angular plugins "Angular" "http://my-grafana.example.com/d/ef5e2c21-88aa-4619-a5db-786cc1dd37a9/angular":
2023/08/17 11:17:13 Found angular panel "Panel two" ("akumuli-datasource")
2023/08/17 11:17:13 Found panel with angular data source "Angular" ("grafana-worldmap-panel")
2023/08/17 11:17:13 Found dashboard with Angular plugins "Datasource tests - Elasticsearch v7" "http://my-grafana.example.com/d/Y-RvmuRWk/datasource-tests-elasticsearch-v7":
2023/08/17 11:17:13 Found panel with angular data source "World map panel" ("grafana-worldmap-panel")
2023/08/17 11:17:14 Found dashboard with Angular plugins "New dashboard" "http://my-grafana.example.com/d/e10a098c-ad80-4d3c-b979-c39a4ce41183/new-dashboard":
2023/08/17 11:17:14 Found angular panel "My panel" ("akumuli-datasource")Pass flag -j to the program to output in JSON format to stdout. All other messages will be sent to stderr. The example below will produce a valid "output.json" file that can be used with other tools.
GRAFANA_TOKEN=glsa_aaaaaaaaaaa ./detect-angular-dashboards http://my-grafana.example.com/api | tee output.json
2023/08/17 11:25:54 Detecting Angular dashboards for "http://my-grafana.example.com/api"
[
{
"Detections": [
{
"PluginID": "akumuli-datasource",
"DetectionType": "datasource",
"Title": "Panel two"
},
{
"PluginID": "grafana-worldmap-panel",
"DetectionType": "panel",
"Title": "Angular"
}
],
"URL": "http://my-grafana.example.com/d/ef5e2c21-88aa-4619-a5db-786cc1dd37a9/angular",
"Title": "Angular",
"Folder": "Angular deprecation",
"UpdatedBy": "admin",
"CreatedBy": "admin",
"Created": "2024-02-22T14:08:06+01:00",
"Updated": "2024-02-22T14:08:06+01:00"
},
{
"Detections": [
{
"PluginID": "grafana-worldmap-panel",
"DetectionType": "panel",
"Title": "World map panel"
}
],
"URL": "http://my-grafana.example.com/d/Y-RvmuRWk/datasource-tests-elasticsearch-v7",
"Title": "Datasource tests - Elasticsearch v7",
"Folder": "Angular deprecation",
"UpdatedBy": "admin",
"CreatedBy": "admin",
"Created": "2024-02-22T14:08:06+01:00",
"Updated": "2024-02-22T14:08:06+01:00"
},
{
"Detections": [
{
"PluginID": "akumuli-datasource",
"DetectionType": "datasource",
"Title": "My panel"
}
],
"URL": "http://my-grafana.example.com/d/e10a098c-ad80-4d3c-b979-c39a4ce41183/new-dashboard",
"Title": "New dashboard",
"Folder": "Angular deprecation",
"UpdatedBy": "admin",
"CreatedBy": "admin",
"Created": "2024-02-22T14:08:06+01:00",
"Updated": "2024-02-22T14:08:06+01:00"
}
]You can use tools such as jq combined with JSON output (-j) to get some useful information, such as:
./detect-angular-dashboards -j | jq '. | length'
36./detect-angular-dashboards -j | jq -r '.[].URL'
http://127.0.0.1:3000/d/e1bd7dd5-2ee2-4e47-8e16-4c43c7c12277/a-dashboard-that-contains-some-angular-plugins
http://127.0.0.1:3000/d/7MeksYbmk/alerting-with-testdata
http://127.0.0.1:3000/d/cf2efc3b-1990-4855-9977-32a55fb27452/an-old-dashboard./detect-angular-dashboards -j | jq -r ".[].Detections[].PluginID" | sort | uniq
akumuli-datasource
grafana-polystat-panel
grafana-worldmap-panel
graph
table-old./detect-angular-dashboards -j | jq -r ".[].Detections[].PluginID" | sort | uniq -c | sort -nr
222 graph
7 table-old
4 grafana-polystat-panel
2 grafana-worldmap-panel
1 akumuli-datasourceIf you have multiple organizations on your Grafana instance, you have to run the tool against each organization. To do so, you first have to create a service account and token for each organization, and then run the program with each service account token. The Grafana URL is the same for every organization.
You can download pre-built binaries from the releases section.
Then, run the program. Replace http://127.0.0.1:3000 with the URL of your Grafana instance.
GRAFANA_TOKEN=abcd ./detect-angular-dashboards http://127.0.0.1:3000/apiYou need to install Go and Mage.
Then, clone the repository, build and run the program. Replace http://127.0.0.1:3000 with the URL of your Grafana instance.
mage build:current
GRAFANA_TOKEN=abcd ./dist/linux_amd64/detect-angular-dashboards http://127.0.0.1:3000/apiClone the repository and build the Docker image. Replace http://127.0.0.1:3000 with the URL of your Grafana instance.
docker build -t detect-angular-dashboards .
docker run --rm -it -e GRAFANA_TOKEN=abcd detect-angular-dashboards http://172.17.0.1:3000/apiApache License 2.0
