Skip to content

Commit 16bf0b2

Browse files
committed
Update README
1 parent f703718 commit 16bf0b2

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

README.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# detect-angular-dashboards
22

3-
Detect angular dashboards in a running Grafana instance using Grafana API.
3+
Detect dashboards depending on Angular data source and panel plugins on a running Grafana instance using the Grafana API.
44

55
Compatible with Grafana OSS, Grafana Enterprise, On-Prem and Grafana Cloud.
66

7+
[Read more about Angular support deprecation in our documentation](https://grafana.com/docs/grafana/latest/developers/angular_deprecation/).
8+
79
## Configuration
810

911
The program requires a service account and API key to work properly.
@@ -32,7 +34,21 @@ Then, create a service account token for the newly created service account and s
3234

3335
## Usage
3436

35-
### Pre-built binaries
37+
### Example
38+
39+
```bash
40+
GRAFANA_TOKEN=glsa_aaaaaaaaaaa ./detect-angular-dashboards http://my-grafana.example.com/api
41+
2023/08/04 16:36:50 Detecting Angular dashboards for "http://my-grafana.example.com/api"
42+
2023/08/04 16:36:50 Found dashboard with Angular plugins "Angular" "http://my-grafana.example.com/api/d/daa8ddc2-1d1a-45c9-9691-6b87f8f35e5f/angular":
43+
2023/08/04 16:36:50 Found angular panel "satellogic-3d-globe-panel"
44+
2023/08/04 16:36:50 Found angular data source "akumuli-datasource"
45+
2023/08/04 16:36:50 Found angular data source "akumuli-datasource"
46+
2023/08/04 16:36:50 Found angular panel "pr0ps-trackmap-panel"
47+
2023/08/04 16:36:50 Found dashboard with Angular plugins "Angular 2" "http://my-grafana.example.com/api/d/fdca7a20-93bd-4e00-90b9-71543ceeaca2/angular-2":
48+
2023/08/04 16:36:50 Found angular data source "akumuli-datasource"
49+
```
50+
51+
### Using pre-built binaries
3652

3753
You can download pre-built binaries from the [releases](https://github.com/grafana/detect-angular-dashboards/releases) section.
3854

@@ -44,7 +60,7 @@ GRAFANA_TOKEN=abcd ./detect-angular-dashboards [GRAFANA_URL=http://127.0.0.1:300
4460

4561
### Building from source
4662

47-
You need to install Go and [Mage](https://magefile.org/).
63+
You need to install [Go](https://go.dev) and [Mage](https://magefile.org/).
4864

4965
Then, clone the repository, build and run the program:
5066

0 commit comments

Comments
 (0)