https://github.com/skx/dashboard
Redis & node.js powered dashboard skeleton
https://github.com/skx/dashboard
Last synced: 9 months ago
JSON representation
Redis & node.js powered dashboard skeleton
- Host: GitHub
- URL: https://github.com/skx/dashboard
- Owner: skx
- Created: 2013-01-17T09:13:22.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2013-09-25T12:14:41.000Z (over 12 years ago)
- Last Synced: 2025-03-29T21:51:09.283Z (10 months ago)
- Language: JavaScript
- Homepage: http://www.debian-administration.org/articles/682
- Size: 234 KB
- Stars: 8
- Watchers: 3
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
dashboard
=========
This is a simple dashboard-skeleton, which allows the submission of
events into a rotating buffer. New events push out old ones, and
we cap the events to the the most recent 1000.
Submission is handled via [node.js](http://nodejs.org), and storage is handled
by [Redis](http://redis.io/).
This server was discussed in the article [Building a simple dashboard with redis and node.js ](http://www.debian-administration.org/articles/682).
Installation
------------
Assuming you have `node.js` and `redis` installed then you may launch
the server by running:
nodejs ./dashboard.js
This will result in a process accepting UDP submissions on port 4433.
Submitting Events
-----------------
Submitting events is as simple as firing UDP packets at the server which
is now running.
> **NOTE**: The server will bind on all available interfaces, so you should firewall submissions from malicious hosts.
There is a sample perl-client included to submit events to the `dashboard.js` server
running on the localhost.
perl submit.pl "This is a test"
perl submit.pl "I like cake."
Viewing Events
--------------
There is a simple Ruby-based server supplied which would make a good
starting point for a more featureful event-viewer.
Assuming you have Ruby, and the sinatra + redis gems installed you can
launch the server with:
cd ./viewer/
./server
This will launch a server which will process two URLs:
* http://localhost:9999/
* The front-page of the application.
* http://localhost:9999/events/
* Return a JSON array of hashes, corresponding to each message.
The front-page uses jQuery to dynamically load the JSON array and display it. You
can see [a screenshot here](https://raw.github.com/skx/dashboard/master/viewer/screenshot.png).
Problems
--------
Please report any issue via the github repository:
* https://github.com/skx/dashboard
License
-------
BSD 3-clause.
Author
------
Steve Kemp