indrabasak / hystrix-viewer

Javascript library for viewing Hystrix Dropwizard metrics.

HystrixViewer.js is a simple JavaScript library for monitoring Hystrix Metrics in real time. It's a port of Hystrix Dashboard and relies on Hystrix metrics instead of Hystrix stream.

Examples

This library is very easy to use. You can create a Hystrix Dashboard by calling addHystrixDashboard method. The method takes a div id.

hystrixViewer.addHystrixDashboard('#hystrix-div');
hystrixViewer.refresh(data);

The viewer can be updated by calling refresh method.

hystrixViewer.refresh(data);

Get Started

1. Download all the javascript and css files from dist directory.
2. The documentation and working example can be found here in demo.

Dependencies

The HystrixViewer depends on the following libraries:

1. D3 is a JavaScript library for manipulating documents based on data.
2. jQuery is a quintessential JavaScriptIt for manipulating HTML documents.

Build

1. Check out the project.
2. Install Node.js.
3. Install gulp from the project root directory.

    npm install gulp

4. Install the library's dependencies:

    npm install

5. To build the Javascript library, type:

    gulp build:js

P.S. If your OS does not recognize gulp, trying installing command line interface of gulp by typing:

    npm install --global gulp-cli

6. To build the css library, type

    gulp build:css

7. To build everything at the same time, type

    gulp

8. To build with Google closure compiler, type

    gulp compile

9. To unit test, type

    gulp test

License

The HystrixViewer.js code is shared under the terms of Apache License v2.0.