Git Product home page Git Product logo

perfboard's Introduction

about

Perfboard is a web performance dashboard based on PHP. It's a by-product of my master's thesis, so some parts are more complicated than they neccessarly need to be, on the other hand it's more a proof of concept than a sophisticated product. if you don't like some parts, feel free to contribute.

Small Screen Example

perfboard consists of three parts:

  1. the sensor(s). a sensor runs on (remote) web server and utilizes monitoring plugin's check_http command to check the performance of a monitored HTTP object.
  2. the collector collects data from the sensors and stores the result into local files for use with the frontend.
  3. the frontend is a simple visualization of the sensor data.

The communication between the collector and the sensors is based on RSA signatures.

installation

prerequisites

before starting, you should generate your RSA keypair. you can do this easily by executing the generate-keypair.sh command in the project's root directory. this will generate a key-pair in your "keys" directory. your identity is a UUID, your keys are named by that UUID. So if youe UUID were 4a2901f3-716c-4522-a03e-959a4acbd04a, it would look like this:

$ ls keys/
4a2901f3-716c-4522-a03e-959a4acbd04a.pem
4a2901f3-716c-4522-a03e-959a4acbd04a.pub

add this to your config.php.

you also need to install the latest monitoring-plugins and mtr package on all hosts, you plan to host your sensors on. In Ubuntu Linux, this can be done by executing

$ sudo apt-get install nagios-plugins-basic mtr

installing the sensors

as long as you point your document root to the sensor/ subdirectory, it should be safe to simple deploy the whole project directory to your webserver. If you like to limit what you deploy, the required files (continuing with 4a2901f3-716c-4522-a03e-959a4acbd04a as your UUID) are:

keys/
keys/4a2901f3-716c-4522-a03e-959a4acbd04a.pub
config.php
sensor/
sensor/index.php

if you are utilizing your friend's servers as sensors, you should of course not give away your private key (the .pem-file).

installing the collector and the frontend

collector and frontend need to run on the same file system.

you can run the collector from anywhere you want. depending on how often you like to update your data, adjust your crontab and be happy:

* * * * * /path/to/perfboard/collector/fetch.php

to installing the frontend, point your web server's document root to /path/to/perfboard/frontend/ with index.php beeing your document index.

--- end of file

perfboard's People

Contributors

nohn avatar

Watchers

 avatar James Cloos avatar  avatar

Forkers

tymiles003

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.