https://github.com/alphasights/walnut
Lightweight, simplistic dashboard to monitor web services, CI and applications
https://github.com/alphasights/walnut
Last synced: about 1 year ago
JSON representation
Lightweight, simplistic dashboard to monitor web services, CI and applications
- Host: GitHub
- URL: https://github.com/alphasights/walnut
- Owner: alphasights
- Archived: true
- Created: 2011-07-29T11:54:15.000Z (almost 15 years ago)
- Default Branch: master
- Last Pushed: 2016-10-21T03:04:47.000Z (over 9 years ago)
- Last Synced: 2025-02-22T12:21:36.130Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 71.3 KB
- Stars: 36
- Watchers: 60
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Walnut
=================
This is a tiny pure JS/HTML/CSS app for monitoring third party services, integrating with CI, London metro or whatever you like and displaying it on your wall!
Features
========
* No deployment: JS only
* Five visual states for services
* Plays the [inception](http://inception.davepedu.com/) sound if a service fails
* Polls server every 20 seconds
* Non-blocking
* Good for displaying on a flatscreen TV
[Screenshot](http://i.imgur.com/U8nTW.png?6291)
Service States
--------------
* Green: up and running
* Red: service is misbehaving
* Polling service: making HTTP request to a status api/page
* Pending: good for CI build/test process
* Unknown: HTTP request to a status page/api has failed
Limitations
==========
Due to security reasons browsers do not allow cross-domain AJAX requests, therefore you have to configure your browser accordingly. Please do so at your own risk!
Safari
------
Seems to work by default.
Chrome
------
You will have to disable web security. Pass `-disable-web-security` when starting chrome.
Eg. in OS X:
open /Applications/Google\ Chrome.app --args -disable-web-security
Other Browsers
--------------
Haven't tested yet. Please report in Issues if you can get it running on other browsers.
Monitored Services
==================
* Heroku Apps
* Heroku Tools
* Amazon EC2 N.Virginia (Heroku lives there)
* MongoHQ Rose
* Mongolab DB
* Pusher App
* Rackspace Email
* Github
* Cloudmailin
* Exceptional
* London Underground Jubilee line (!)
* Twilio
* Plex
* SickBeard
* Couch Potato
* SABnzbd
Monitoring other services
=========================
It is very easy to add any service you want. Just add another service to the `services.js` file. Here's a helpful example:
Service({
name: 'Some Cool Apps', // will be displayed in the view
url: 'https://example.com/status.json', // url to call
dataType: "json", // optional. datatype to set in http header
username: 'jamesbond', // optional. http basic auth username
password: 'secret007', // optional. http basic auth password
// a function to parse the response.
// must return true, false or "pending"
status: function(response) { // In case of HTML response jQuery can be used
return JSON.parse(response)["status"] == "ok";
}
});
Monitoring Jenkins CI
----------------------
Example of how to monitor Jenkins CI. Will display grey icon while building
Service({
name: 'Jenkins',
url: 'http://myjenkinsurl.com/job/Prject/lastBuild/api/json',
username: 'jenkinsuser',
password: 'someweirdpassword',
dataType: "json",
status: function(response) {
if(response["building"]){
return "pending";
};
return response["result"].toLowerCase() == "success";
}
});
You shouldn't need to touch `app.js` at all.
HTTPS URLs using self-signed certificates
-----------------------------------------
You may want to monitor an HTTPS service that uses a self-signed certificate. Your
browser will abort request unless you trust that certificate. To do so, open the
service's URL in your browser, and accept whatever security exception your browser
requires.
Styling
=======
You should modify `src/screen.sass`. To compile it to css just run `sass src/screen.sass stylesheets/screen.css` in a project directory. You can also modify `stylesheets/screen.css` directly if you can't use sass for some serious reason.
Contributing
============
Please make pull requests with useful services to monitor, SASS/CSS styles, new fancy sounds or any other cool features.
Credits
=======
John Griffin, Tor Erik Linnerud, Tadas Tamosauskas
Icons: [Glyphish free icon set](http://glyphish.com/)