Skip to content
This repository was archived by the owner on Apr 27, 2023. It is now read-only.

Commit 5cc99e5

Browse files
committed
Readme for released plugin
1 parent d0f24f2 commit 5cc99e5

File tree

1 file changed

+23
-24
lines changed

1 file changed

+23
-24
lines changed

README.md

Lines changed: 23 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,26 @@
1-
# Pyroscope Grafana Data Source Plugin
1+
# Pyroscope Grafana Panel Plugin
22

33
## Getting started
44

5-
1. Install dependencies
6-
7-
```bash
8-
yarn install
9-
```
10-
11-
2. Build plugin in development mode or run in watch mode
12-
13-
```bash
14-
yarn dev
15-
```
16-
17-
or
18-
19-
```bash
20-
yarn watch
21-
```
22-
23-
3. Build plugin in production mode
24-
25-
```bash
26-
yarn build
27-
```
5+
1. Get the zip file from the Github [releases page](https://github.com/pyroscope-io/grafana-panel-plugin/tags) on panel plugin repo.
6+
2. Get the zip file from the Github [releases page](https://github.com/pyroscope-io/grafana-datasource-plugin/tags) on datasource plugin repo.
7+
3. Extract zip files into the plugins directory for Grafana.
8+
4. Restart Grafana
9+
5. Open Grafana ang go to **Configuratin -> Plugins**
10+
6. Check that plugins are available:
11+
![plugins-list](https://raw.githubusercontent.com/pyroscope-io/grafana-panel-plugin/main/docs/assets/pluginslist.jpg)
12+
7. Set up data source plugin:
13+
* **Configuration -> Data Sources -> Add data source**
14+
* click on `pyroscope-datasource`
15+
* Specify Pyroscope host in `Endpoint` field:
16+
![endpoint](https://raw.githubusercontent.com/pyroscope-io/grafana-panel-plugin/main/docs/assets/endpoint.jpg)
17+
8. Set up panel plugin:
18+
* Add an empty panel on your dashboard
19+
* Select `pyroscop-panel` from Visualization list
20+
* Under panel view in Query tab select `pyroscope-datasource`
21+
* In `Application name` input specify app name
22+
* Click `Apply`
23+
![settings](https://raw.githubusercontent.com/pyroscope-io/grafana-panel-plugin/main/docs/assets/settings.jpg)
24+
25+
Congratulations! Now you can monitor application flamegraph on your Grafana dashboard!
26+
![dashboard](https://raw.githubusercontent.com/pyroscope-io/grafana-panel-plugin/main/docs/assets/dashboard.jpg)

0 commit comments

Comments
 (0)