2022-06-03 02:01:19 +02:00
# dashboard
2022-09-14 13:36:46 +02:00
![screenshot ](https://data.alemi.dev/dashboard.png )
2022-06-09 02:52:17 +02:00
A data aggregating dashboard, capable of periodically fetching, parsing, archiving and plotting data.
2022-09-14 13:36:46 +02:00
### Name
2022-06-14 03:10:14 +02:00
Do you have a good name idea for this project? [Let me know ](https://alemi.dev/suggestions/What%27s%20a%20good%20name%20for%20the%20project%3F )!
2022-09-14 13:36:46 +02:00
## How it works
This software periodically (customizable interval) makes a GET request to given URL, then applies all metric JQL queries to the JSON output, then inserts all extracted points into its underlying SQLite.
Each panel displays all points gathered respecting limits, without redrawing until user interacts with UI or data changes.
If no "x" query is specified, current time will be used (as timestamp) for each sample "x" coordinate, making this software especially useful for timeseries.
2022-06-09 02:52:17 +02:00
## Features
2022-09-14 13:36:46 +02:00
* parse JSON apis with [JQL syntax ](https://github.com/yamafaktory/jql )
* embedded SQLite, no need for external database
* import/export metrics data to/from CSV
* split data from 1 fetch to many metrics
* customize source color and name, toggle them (visibility or fetching)
* customize panels (size, span, offset)
* reduce data points with average or sampling
* per-source query interval
* light/dark mode
2022-06-09 02:52:17 +02:00
## Usage
This program will work on a database stored in `$HOME/.local/share/dashboard.db` . By default, nothing will be shown.
2022-09-14 13:36:46 +02:00
To add sources or panels, toggle edit mode (top left). Once in edit mode you can:
* Add panels (top bar)
* Add sources (in source sidebar, bottom)
* Edit panels (name, height, display options)
* Edit sources (name, color, query, panel)
2022-06-09 02:52:17 +02:00
2022-09-14 13:36:46 +02:00
# Installation
`cargo build --release` , then drop it in your `~/.local/bin` . Done, have fun hoarding data!