This is a Graylog stream dashboard that runs in your shell. It is meant to be a perfect companion for example when performing a release on the main monitor and having the dashboard on the second monitor to keep an eye on errors and exceptions on your platform.
The most important library we use is blessed-contrib by Yaron Naveh. Great job on that!
The dashboard should run on Linux and OSX. Please report any issues in the issue tracker.
Easy. First create a configuration file at ~/.graylog_dashboard that contains your Graylog username and password:
username: lennart
password: sEcReT
That's it. Now install start the dashboard: (You'll have to have node.js installed. Protip: It's in homebrew if you are on OSX.)
$ npm install graylog-cli-dashboard -g
$ graylog-dashboard --stream-id [stream-id] --host [graylog-server REST API URL]
Full example:
$ graylog-dashboard --stream-id 549d7f9fbee84e568d181655 --host http://graylog.example.org:12900
Make sure to run this with a recent version of node.js. (Tested and developed with node 0.10.35 on OSX Yosemite)
You must have the graylog-dashboard executable that gets installed by NPM in your PATH. This is usually the case after installing
NPM in the first place but the output of npm install should show you where it was installed if you cannot find it:
/usr/local/share/npm/bin/graylog-dashboard -> /usr/local/share/npm/lib/node_modules/graylog-cli-dashboard/graylog-dashboard.js
# In this OSX example graylog-dashboard has been linked to the graylog-dashboard.js file in /usr/local/share/npm/...
# Execute /usr/local/share/npm/bin/graylog-dashboard to try it out
Because this stuff looks like it is from space we suspect that people like to show it. Send us a photo of your dashboard running somewhere and we are more than happy to publish it here. Bonus points for messy desks or interesting stuff in the background.
This is a few helpful notes for all of us who do not regularly work with the node/NPM ecosystem and can't remember how to do stuff.
$ npm version [<newversion> | major | minor | patch]
$ git push origin master && git push --tags
$ npm publish