https://github.com/qubyte/warden
:cop: A wrapper for Panopticon that makes adding measurements to your codebase simple and efficient.
https://github.com/qubyte/warden
Last synced: about 1 month ago
JSON representation
:cop: A wrapper for Panopticon that makes adding measurements to your codebase simple and efficient.
- Host: GitHub
- URL: https://github.com/qubyte/warden
- Owner: qubyte
- License: mit
- Created: 2014-02-15T19:16:10.000Z (over 11 years ago)
- Default Branch: develop
- Last Pushed: 2017-09-14T23:26:09.000Z (over 7 years ago)
- Last Synced: 2025-03-15T22:16:31.142Z (2 months ago)
- Language: JavaScript
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# warden
[](https://coveralls.io/r/qubyte/warden?branch=master)
[](https://travis-ci.org/qubyte/warden)
[](https://david-dm.org/qubyte/warden)
A wrapper for [Panopticon](https://github.com/Wizcorp/panopticon) that makes adding measurements to your codebase simple and efficient.
Panopticon already makes it easy to sample data and aggregate it over a Node.js cluster. What warden adds is the ability to use `require('warden')` to gain access to one or more Panopticon instances anywhere in your project. No need to roll your own module to contain panoptica and use awkward path-like `requires`'s to use it.
## Setup
You should require warden and call it on both the cluster master and cluster workers of your service. For example:
```javascript
var cluster = require('cluster');
var warden = require('warden');
// Calling setup before cluster logic is an easy way to call it on all processes.
warden.setup([/* intervals */], { /* Panopticon config */ });
// warden.setup should be run on all processes. Below is how I handle cluster.
if (cluster.isMaster && process.env.NODE_ENV === 'production') {
require('./master.js'); // Handles all master logic.
} else {
require('./worker.js'); // Entry point to the service logic.
}
```
The configuration argument is the same as that of Panopticon, but you should omit the `interval` field since this is overridden by the intervals argument. It turns out to be useful to have more than one instance of Panopticon with different intervals.
## Usage
Once `warden.setup` has been called, you can simply require warden in any module you want to collect measurements in. The warden has the same measurement methods as Panopticon, and you can even add your own. See the [Panopticon documentation](https://github.com/Wizcorp/panopticon#panopticonsamplepath-id-n) for the logger methods. For example, an express middleware that measures response time could look like:
```javascript
var warden = require('warden');
module.exports = function (req, res, next) {
'use strict';
var t0 = process.hrtime();
res.once('finish', function () {
// Δt in high resolution. Panopticon has a timedSample method that uses these.
var t1 = process.hrtime(t0);
// For grouping related measurements.
var path = ['webservice', req.route.path, req.route.method];
warden.timedSample(path, 'responseTime' t1);
});
next();
}
```
## Delivery
After each interval elapses, aggregated data is emitted on the `delivery` event of warden. This emission only happens on master, so you must handle the data in your master process. The form of the data can be customized during setup. See [here](https://github.com/Wizcorp/panopticon#transformer) for information.