README.md

Patra project visualizes Dropwizard Metrics in a user friendly way. Dropwizard metrics are formerly known as Coda Hale / Yammer metrics.

Patra is a collection of HTML, JavaScript, and CSS files that dynamically generates pages for viewing metrics.

Get Started

Download all the HTML, JavaScript and CSS files from the dist directory.

To use Patra, take a look at the index.html page and customize it by modifying the URL in the patra.init method. By default, it points to http://localhost:8080/metrics/metrics

patra.init('http://localhost:8080/metrics/metrics');

Dependencies

Patra 2.0 depends on the following libraries:

1. MetricsViewer.js (2.0.0) is a JavaScript library for displaying Dropwizard Metrics data as line graphs.
2. MetricsGraphics.js (2.15.6) is a JavaScript library for visualizing time-series data.
3. D3 (5.16.0) is a JavaScript library for manipulating documents based on data. MetricsGraphics.js is based on D3 library.
4. jQuery (3.5.1) is a quintessential JavaScript library for manipulating HTML documents.
5. jsTree (3.3.9) is a JavaScript library for creating interactive trees.

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 Patra code is shared under the terms of Apache License v2.0.