Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/it4innovations/snailwatch
Continous performance monitoring service (https://snailwatch.readthedocs.io/en/latest).
https://github.com/it4innovations/snailwatch
benchmarking continuous-integration performance-monitoring performance-visualization
Last synced: about 1 month ago
JSON representation
Continous performance monitoring service (https://snailwatch.readthedocs.io/en/latest).
- Host: GitHub
- URL: https://github.com/it4innovations/snailwatch
- Owner: It4innovations
- License: mit
- Created: 2018-10-16T09:36:49.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T02:07:29.000Z (about 2 years ago)
- Last Synced: 2023-07-31T13:56:00.825Z (over 1 year ago)
- Topics: benchmarking, continuous-integration, performance-monitoring, performance-visualization
- Language: TypeScript
- Size: 5.07 MB
- Stars: 7
- Watchers: 3
- Forks: 2
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Snailwatch
This repository contains code for the continous performance monitoring service
**Snailwatch**.
Snailwatch is a database for your benchmark results that can automatically
notify you when a performance regression is detected. It also
offers a dashboard with historical trends of your app's performance.
You can find its documentation [here](https://snailwatch.readthedocs.io/en/latest).
### Repository structure
- **server** - Snailwatch service (REST API + database)
- **dashboard** - web dashboard for visualising benchmark results
- **client** - helper Python library for uploading measurements
### Quick setup
To use Snailwatch, you first have to deploy it.
If you want to quickly deploy both the server and the dashboard with Docker,
just run the following command in the root of the repository:
```bash
$ ADMIN_TOKEN=... DB_DIR=~/snailwatch docker-compose up
```
This will start both the server and the dashboard at once. The server
will be available at `http://localhost:5000` and the dashboard will
be available at `http://localhost:3000`.
ADMIN_TOKEN is a secret token required for admin actions and DB_DIR
specifies in which directory should the database be stored.
### Dashboard example
### Authors
- Jakub Beránek ([email protected])
- Stanislav Böhm ([email protected])
### License
Snailwatch is MIT licensed.