Skip to content

Update docs #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 21, 2023
Merged

Update docs #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 4 additions & 21 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,12 @@ This data source plugin allows you to query and visualize log data stored in Par

## Pre-requisites

[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).
- [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).
- Grafana installed and running. Read more on [Grafana documentation](https://grafana.com/docs/grafana/latest/installation/).

## Installation
## Installation & Usage

- 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).

- Add Parseable as a data source at the data source configuration page.

- 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.

- Push the `Save and Test` button, if there is an error message, check the credentials and connection.

![config](https://raw.githubusercontent.com/parseablehq/parseable-datasource/main/src/img/configuration.png)

## Usage

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.

### Importing Dashboards

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.

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`.
Refer the Parseable Grafana documentation page: [https://www.parseable.io/docs/integrations/grafana](https://www.parseable.io/docs/integrations/grafana).

## Screenshots

Expand Down