Skip to content

Commit 13edb2c

Browse files
committed
update readme
1 parent 1a641c5 commit 13edb2c

File tree

1 file changed

+24
-13
lines changed

1 file changed

+24
-13
lines changed

README.md

Lines changed: 24 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,38 @@
22

33
[![Build](https://github.com/grafana/grafana-starter-datasource/workflows/CI/badge.svg)](https://github.com/grafana/grafana-starter-datasource/actions?query=workflow%3A%22CI%22)
44

5-
This plugin provides a data source to connect a REST API to [nodegraph](https://grafana.com/docs/grafana/latest/visualizations/node-graph/) panel of Grafana.
5+
This plugin provides a data source to connect a REST API to [nodegraph](https://grafana.com/docs/grafana/latest/visualizations/node-graph/) panel of Grafana. It is [signed and published by Grafana](https://grafana.com/grafana/plugins/hamedkarbasi93-nodegraphapi-datasource/).
66

77
![Graph Example](https://raw.githubusercontent.com/hoptical/nodegraph-api-plugin/f447b74ecefd827b388e791a34792730e9a9a11d/src/img/graph-example.png)
88

9+
## Requirements
10+
- **Grafana 7.5+**
11+
912
## Getting started
1013

11-
1. Use Grafana 7.4 or higher
14+
### Installation via grafana-cli tool
1215

13-
- Download and place the data source in `grafana/plugins` directory.
16+
Use the grafana-cli tool to install Node Graph API from the commandline:
1417

15-
This plugin is not signed yet; Grafana will not allow loading it by default. You have to enable it by adding:
18+
```bash
19+
grafana-cli plugins install hamedkarbasi93-nodegraphapi-datasource
20+
```
1621

17-
for example, if you are using Grafana with containers, add:
22+
The plugin will be installed into your grafana plugins directory; the default is `/var/lib/grafana/plugins`. [More information on the cli tool](https://grafana.com/docs/grafana/latest/administration/cli/#plugins-commands).
1823

19-
```yaml
20-
-e "GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=hamedkarbasi93-nodegraphapi-datasource"
21-
```
24+
### Installation via zip file
25+
26+
Alternatively, you can manually download the [latest](https://github.com/hoptical/nodegraph-api-plugin/releases/latest) release .zip file and unpack it into your grafana plugins directory; the default is `/var/lib/grafana/plugins`.
2227

23-
2. You can now add the data source. Just enter the URL of your API app and push "Save & Test." You will get an error in case of connection failure.
28+
### Plugin Configuration
2429

25-
> Note: The browser should have access to the application, not the Grafana server.
30+
You can now add the data source. Just enter the URL of your API app and push "Save & Test." You will get an error in case of connection failure.
31+
32+
> Important note: The browser should have access to the application, not the Grafana server.
2633
2734
![Add Datasource](https://raw.githubusercontent.com/hoptical/nodegraph-api-plugin/f447b74ecefd827b388e791a34792730e9a9a11d/src/img/add-datasource.png)
2835

29-
3. In the Grafana dashboard, pick the Nodegraph panel and visualize the graph.
36+
In the Grafana dashboard, pick the Nodegraph panel and visualize the graph.
3037

3138
## API Configuration
3239

@@ -178,9 +185,9 @@ The application will be started on `http://localhost:5000`
178185

179186
## Query Configuration
180187
You can pass a query string to apply for the data endpoint of the graph via *Query String*. Like any other query, you can utilize variables too:
181-
188+
182189
![Add Datasource](https://raw.githubusercontent.com/hoptical/nodegraph-api-plugin/22a1933b1e012602c817817f4583697e25028382/src/img/query-string.png)
183-
190+
184191
With variable `$service` defined as `processors`, above query will produce this endpoint:
185192
`/api/graph/data?query=text1&service=processors`
186193
## Compiling the data source by yourself
@@ -209,6 +216,10 @@ You can pass a query string to apply for the data endpoint of the graph via *Que
209216
yarn build
210217
```
211218

219+
## Roadmap
220+
221+
- Convert the plugin to a backend data source. This will prevent the client browser necessity to connect to the API server.
222+
212223
## Learn more
213224

214225
- [Build a data source plugin tutorial](https://grafana.com/tutorials/build-a-data-source-plugin)

0 commit comments

Comments
 (0)