Browse Source

upd readme

master
rozetko 1 year ago
parent
commit
3febdc8f77
  1. 82
      README.md

82
README.md

@ -6,85 +6,27 @@ Supported datasources:
- MySQL - MySQL
- PostgreSQL - PostgreSQL
We work on expanding this list. If you would like us to support any particular datasource -- please let us know at ping@corpglory.com
## Prerequisites ## Prerequisites
- [Grafana 9.0.0+](https://grafana.com/grafana/download) - [Grafana 9.0.0+](https://grafana.com/grafana/download)
- [Grafana Data Exporter](https://code.corpglory.net/corpglory/grafana-data-exporter) - [Grafana Data Exporter](https://code.corpglory.net/corpglory/grafana-data-exporter)
- set Grafana `app_mode` as `development`:
- find the configuration file: [https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#configuration-file-location](https://grafana.com/docs/grafana/latest/setup-grafana/configure-grafana/#configuration-file-location)
- change `app_mode = production` to `app_mode = development`
- restart Grafana
## Plugin installation
The easiest way to install plugins is by using the `grafana-cli` tool which is bundled with Grafana. See [Using grafana-cli](#using-grafana-cli) paragraph.
If there is no `grafana-cli` tool in your system, plugins can be installed [manually](#manual-installation).
### Table of contents
- [Using grafana-cli](#using-grafana-cli)
- [Install plugin](#install-update-plugin)
- [Manual installation](#manual-installation)
- [Docker installation](#docker-installation)
### Using grafana-cli
Grafana docs about plugin installation: [https://grafana.com/docs/grafana/latest/cli/#plugins-commands](https://grafana.com/docs/grafana/latest/cli/#plugins-commands).
#### Install / update plugin
```bash
grafana-cli --pluginUrl "https://code.corpglory.net/attachments/03b4c35b-575a-4d8c-b211-60cc40966c72" plugins install corpglory-dataexporter-app
sudo systemctl restart grafana-server
```
### Manual installation
- Navigate to Grafana plugins directory:
- For Grafana installed from `.deb`/`.rpm` package:
- `/var/lib/grafana/plugins`
- For Grafana installed using Standalone Linux Binaries or source:
- `<GRAFANA_PATH>/data/plugins`
- Download corpglory-dataexporter-app
```bash
wget https://code.corpglory.net/attachments/07908282-dc3b-4ca1-83d5-224c4139bd89 -O corpglory-dataexporter-app.tar.gz
```
- Unpack downloaded files
```bash
tar -zxvf corpglory-dataexporter-app.tar.gz
```
- Restart Grafana
- For Grafana installed from `.deb`/`.rpm` package:
- `systemctl restart grafana-server`
- For Grafana installed using Standalone Linux Binaries or source:
- Stop any running instances of grafana-server
- Start grafana-server: `cd <GRAFANA_PATH> && ./bin/grafana-server`
### Docker installation
You can install Data Exporter App to Grafana in Docker passing it as the environment variable.
```bash
docker run \
-p 3000:3000 \
-e "GF_INSTALL_PLUGINS=https://code.corpglory.net/attachments/03b4c35b-575a-4d8c-b211-60cc40966c72;corpglory-dataexporter-app" \
grafana/grafana
```
#### Useful links
- Grafana docs about Docker installation: [https://docs.grafana.org/installation/docker/#installing-plugins-from-other-sources](https://docs.grafana.org/installation/docker/#installing-plugins-from-other-sources)
## Plugin Configuration ## Plugin Configuration
- 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 - 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 by Grafana Server) - Fill "DataExporter backend URL" field with the Data Exporter URL (Please note: the URL should be accessible from Grafana Server)
- Click Connect - 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." - 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."
- After this:
- go to a dashboard you'd like to export data from ## Plugin Usage
- click "Add panel" - go to a dashboard you'd like to export data from
- select Data Exporter Panel - click "Add panel"
- select Data Exporter Panel
- click Add Task
- select timerange and query
- click Export
## Support and Consulting ## Support and Consulting

Loading…
Cancel
Save