Skip to content

cetra3/lorikeet-dash

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

31 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Lorikeet Dashboard

A Web Dashboard for Lorikeet:

Takes the lorikeet tests and turns them into a web dashboard.

Installation

You can install it via cargo:

cargo install lorikeet-dash

Usage

You can use your existing lorikeet test.yml file. If you don't have one, here's one to get you started:

CPU Load:
  system: load_avg15m

Disk Free:
  system: disk_free

Memory Free:
  system: mem_free

Check Google:
  http: https://www.google.com

Check Reddit:
  http: https://www.reddit.com

Check Localhost:
  http: http://localhost:3333/

Save this as test.yml run it like so:

lorikeet-dash test.yml

Navigate to http://localhost:3333/ to view the dashboard.

Command Line Options

You can use lorikeet-dash -h to get a list of options:

USAGE:
    lorikeet-dash [OPTIONS] [test-plan]

FLAGS:
    -h, --help       Prints help information
    -V, --version    Prints version information

OPTIONS:
    -c, --config <config>            Configuration File
    -l, --listen <listen>            Listen Address [default: 0.0.0.0:3333]
    -r, --refresh_ms <refresh-ms>    Refresh Interval [default: 10000]

ARGS:
    <test-plan>    Test Plan [default: test.yml]

Frontend Development

Requires NodeJS & Yarn

You can run yarn build in the front/ directory to build the frontend.

Alternatively, you can run yarn start in one window and lorikeet-dash in another to setup a dev environment.

the dist directory is included on master so that you don't need NodeJS to compile it down.