Compare commits
23 Commits
Author | SHA1 | Date |
---|---|---|
rozetko | 3b8bb6bf10 | 11 months ago |
rozetko | 3febdc8f77 | 11 months ago |
rozetko | 75c383299b | 11 months ago |
rozetko | 1ec352d4fe | 11 months ago |
rozetko | 67cd652cad | 11 months ago |
rozetko | 9a48b1df67 | 11 months ago |
rozetko | d016a3b4e6 | 11 months ago |
rozetko | 5a223eddb1 | 11 months ago |
rozetko | 3079ce5936 | 11 months ago |
rozetko | cb7982245a | 11 months ago |
rozetko | 507757bc72 | 11 months ago |
rozetko | 2f80b19690 | 11 months ago |
rozetko | de2bafe7d7 | 1 year ago |
rozetko | 95cef43253 | 1 year ago |
rozetko | 562eb7798a | 1 year ago |
rozetko | a57f704113 | 1 year ago |
vargburz | 1e121c4b75 | 1 year ago |
vargburz | b4957048cb | 1 year ago |
rozetko | 1c6549412a | 1 year ago |
rozetko | bc3313515d | 1 year ago |
rozetko | 508a9ccb41 | 1 year ago |
rozetko | 82f3bc3429 | 1 year ago |
rozetko | 5952d799df | 1 year ago |
8 changed files with 71 additions and 82 deletions
@ -1,79 +1,36 @@
|
||||
# Grafana app plugin template |
||||
# Grafana Data Exporter App |
||||
|
||||
This template is a starting point for building an app plugin for Grafana. |
||||
Grafana plugin for exporting data from Grafana panels as CSV. |
||||
|
||||
## What are Grafana app plugins? |
||||
Supported datasources: |
||||
- MySQL |
||||
- PostgreSQL |
||||
|
||||
App plugins can let you create a custom out-of-the-box monitoring experience by custom pages, nested datasources and panel plugins. |
||||
We work on expanding this list. If you would like us to support any particular datasource -- please let us know at ping@corpglory.com |
||||
|
||||
## Getting started |
||||
## Prerequisites |
||||
- [Grafana 9.0.0+](https://grafana.com/grafana/download) |
||||
- [Grafana Data Exporter](https://code.corpglory.net/corpglory/grafana-data-exporter) |
||||
|
||||
### Frontend |
||||
## Plugin Configuration |
||||
|
||||
1. Install dependencies |
||||
- Make sure [Grafana Data Exporter](https://code.corpglory.net/corpglory/grafana-data-exporter) is running, and accessible from Grafana Server |
||||
- In Grafana, go to Configuration -> Plugins -> Data Exporter App |
||||
- Fill "DataExporter backend URL" field with the Data Exporter URL (Please note: the URL should be accessible from Grafana Server) |
||||
- Click Connect |
||||
- If Grafana connects to the Data Exporter successfully, you'll see this message: "Plugin is connected! You can now go to a dashboard and add the DataExporter panel there." |
||||
|
||||
```bash |
||||
yarn install |
||||
``` |
||||
## Plugin Usage |
||||
- go to a dashboard you'd like to export data from |
||||
- click "Add panel" |
||||
- select Data Exporter Panel |
||||
- click Add Task |
||||
- select timerange and query |
||||
- click Export |
||||
|
||||
2. Build plugin in development mode or run in watch mode |
||||
## Support and Consulting |
||||
|
||||
```bash |
||||
yarn dev |
||||
Commercial support, professional services **or any help** — send us your inquiry at ping@corpglory.com |
||||
|
||||
# or |
||||
|
||||
yarn watch |
||||
``` |
||||
|
||||
3. Build plugin in production mode |
||||
|
||||
```bash |
||||
yarn build |
||||
``` |
||||
|
||||
4. Run the tests (using Jest) |
||||
|
||||
```bash |
||||
# Runs the tests and watches for changes |
||||
yarn test |
||||
|
||||
# Exists after running all the tests |
||||
yarn lint:ci |
||||
``` |
||||
|
||||
5. Spin up a Grafana instance and run the plugin inside it (using Docker) |
||||
|
||||
```bash |
||||
yarn server |
||||
``` |
||||
|
||||
6. Run the E2E tests (using Cypress) |
||||
|
||||
```bash |
||||
# Spin up a Grafana instance first that we tests against |
||||
yarn server |
||||
|
||||
# Start the tests |
||||
yarn e2e |
||||
``` |
||||
|
||||
7. Run the linter |
||||
|
||||
```bash |
||||
yarn lint |
||||
|
||||
# or |
||||
|
||||
yarn lint:fix |
||||
``` |
||||
|
||||
|
||||
|
||||
## Learn more |
||||
|
||||
Below you can find source code for existing app plugins and other related documentation. |
||||
|
||||
- [Basic app plugin example](https://github.com/grafana/grafana-plugin-examples/tree/master/examples/app-basic#readme) |
||||
- [Plugin.json documentation](https://grafana.com/docs/grafana/latest/developers/plugins/metadata/) |
||||
- [How to sign a plugin?](https://grafana.com/docs/grafana/latest/developers/plugins/sign-a-plugin/) |
||||
## About CorpGlory Inc. |
||||
Grafana Data Exporter is developed by [CorpGlory Inc.](https://corpglory.com/), a company which provides high quality software development, data visualization, Grafana and monitoring consulting. |
||||
|
After Width: | Height: | Size: 48 KiB |
After Width: | Height: | Size: 22 KiB |
Loading…
Reference in new issue