vidi-dashboard
v0.4.0
Published
A reporting dashboard written in node
Downloads
6
Readme
vidi-dashboard
- Lead Maintainer: Dean McDonnell
- Sponsor: nearForm
Vidi: Dashboard is a web app used to chart metrics from Vidi: Metrics. The default installation includes support for charting node processes preloaded with Toolbag. Data is shown on various charts over 120 seconds. Check the Org for more plugins to enhance the dashboard's functionality.
- Work in progress: This module is currently a work in progress.
Running
To run the dashboard,
- Clone this repo
- Run
docker-compose -f test/influx.yml up
- Run
npm install
- Run
npm run build
- Run
npm run start
Also you can watch the files for changes and automatically rebuild the sources by running npm run
watch
in a different terminal.
Demo
A number of premade services are included to demo the dashboard. There are three services that can be ran,
npm run healthy
a healthy low usage processesnpm run leaker
a process that rapidly consumes memory, eventually crashesnpm run sleeper
a process that sleeps the event loop at regular intervals
Simply run each process in a new terminal window, they will appear on the dashboard shortly after starting. To add your own processes simply preload them with Toolbag.
Documentation
This project is in it's infancy, documentation will come after stability.
Contributing
The Vidi: Insights org encourages open and safe participation.
If you feel you can help in any way, be it with documentation, examples, extra testing, or new features please get in touch.
License
Copyright (c) 2016, Dean McDonnell and other contributors. Licensed under MIT.