Skip to content

Commit 386d94e

Browse files
authored
Update docs (#25)
1 parent 19b2083 commit 386d94e

File tree

1 file changed

+4
-21
lines changed

1 file changed

+4
-21
lines changed

README.md

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,12 @@ This data source plugin allows you to query and visualize log data stored in Par
44

55
## Pre-requisites
66

7-
[Parseable server](https://github.com/parseablehq/parseable) setup and receiving logs from your application. Read more on [Parseable documentation](https://www.parseable.io/docs/quick-start).
7+
- [Parseable server](https://github.com/parseablehq/parseable) setup and receiving logs from your application. Read more on [Parseable documentation](https://www.parseable.io/docs/quick-start).
8+
- Grafana installed and running. Read more on [Grafana documentation](https://grafana.com/docs/grafana/latest/installation/).
89

9-
## Installation
10+
## Installation & Usage
1011

11-
- Install the plugin using the Grafana CLI, using the command `grafana-cli plugins install parseable-datasource`. Then restart Grafana. Alternatively, you can install the plugin from your Grafana instance (Configuration > Data sources > Add Data source).
12-
13-
- Add Parseable as a data source at the data source configuration page.
14-
15-
- Configure the data source specifying URL and port like [https://demo.parseable.io:443](https://demo.parseable.io:443). Parseable supports basic auth currently, so toggle the "Basic Auth" option under "Auth" section and enter the username and password under "Basic Auth Details" section. For Parseable demo server use `parseable` as both, username and password.
16-
17-
- Push the `Save and Test` button, if there is an error message, check the credentials and connection.
18-
19-
![config](https://raw.githubusercontent.com/parseablehq/parseable-datasource/main/src/img/configuration.png)
20-
21-
## Usage
22-
23-
Once the plugin is configured with correct Parseable server instance. You can start using it to query logs and visualize them. You can use the query editor to write your own queries.
24-
25-
### Importing Dashboards
26-
27-
This plugin has a a pre-made dashboard called "Parseable Demo Data". You can find it by navigating to the data sources configuration page, selecting the Parseable data source and clicking on the Dashboards tab.
28-
29-
This dashboard is aimed at visualizing the logs stored in the Parseable demo server. You can use it as a starting point for your own dashboards. To use this dashboard, you will need to configure the data source with the Parseable demo server URL [https://demo.parseable.io](https://demo.parseable.io:443) and credentials `parseable`, `parseable`.
12+
Refer the Parseable Grafana documentation page: [https://www.parseable.io/docs/integrations/grafana](https://www.parseable.io/docs/integrations/grafana).
3013

3114
## Screenshots
3215

0 commit comments

Comments
 (0)