https://github.com/commenthol/connect-composer-stats
Statistics for connect-composer middlewares
https://github.com/commenthol/connect-composer-stats
Last synced: 10 months ago
JSON representation
Statistics for connect-composer middlewares
- Host: GitHub
- URL: https://github.com/commenthol/connect-composer-stats
- Owner: commenthol
- License: mit
- Created: 2015-09-23T20:04:32.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-09-25T05:24:49.000Z (over 10 years ago)
- Last Synced: 2025-07-10T10:52:52.106Z (12 months ago)
- Language: JavaScript
- Size: 137 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# connect-composer-stats
> Statistics for connect-composer middlewares
[](https://www.npmjs.com/package/connect-composer-stats/)
[](https://travis-ci.org/commenthol/connect-composer-stats)
Enable runtime measurements for composed middlewares using [connect-composer][] to track down latency problems within middlewares.
Inject either globally or locally into your composed middlewares and dump results into a CVS file.
## Table of Contents
* [Description](#description)
* [Set globally for all composed middlewares](#set-globally-for-all-composed-middlewares)
* [Set locally for a single composed middlewares](#set-locally-for-a-single-composed-middlewares)
* [Wrap arround a single middleware function](#wrap-arround-a-single-middleware-function)
* [Methods](#methods)
* [stats()](#stats)
* [from(fn)](#fromfn)
* [dump(options)](#dumpoptions)
* [data](#data)
* [Contribution and License Agreement](#contribution-and-license-agreement)
* [License](#license)
* [References](#references)
## Description
### Set globally for all composed middlewares
```js
var composestats = require('connect-composer-stats')
var compose = require('connect-composer')
// get new stats object
var stats = composestats()
// globally inject stats use:
compose.options = { stats: stats.from }
// a middleware function
var mw = function (req, res, next) { next() }
// composing the single middlewares
var mws = compose (mw, mw, mw, mw)
var req = {}, res = {}
mws(req, res, function () {
console.log(stats.data)
})
```
### Set locally for a single composed middlewares
```js
var composestats = require('connect-composer-stats')
var compose = require('connect-composer')
// get new stats object
var stats = composestats()
// a middleware function
var mw = function (req, res, next) { next() }
// composing the single middlewares
var mws = compose (mw, mw, mw, mw)
// locally inject stats use:
mws.options = { stats: stats.from }
var req = {}, res = {}
mws(req, res, function () {
console.log(stats.data)
})
```
### Wrap arround a single middleware function
```js
var composestats = require('connect-composer-stats')
var compose = require('connect-composer')
// get new stats object
var stats = composestats()
// a middleware function
var mw = function (req, res, next) { next() }
// wrapping the stats middleware
var wrap = stats.from(mw)
var req = {}, res = {}
wrap(req, res, function () {
wrap(req, res, function () {
console.log(stats.data)
})
})
```
## Methods
### stats()
create statistics for middleware(s)
**Returns**: `Object`, object with functions
### from(fn)
take statistics from middleware function `fn`
**Parameters**
**fn**: `function`, middleware function from which to generate the statistics
**Returns**: `function`, wrapped middleware function
### dump(options)
Dump the collected statistics into a csv file or to stdout
**Parameters**
**options**: `Object`, options
* ns: false, // {Boolean} if `false` output is in milliseconds; if `true` then nanoseconds
* dir: process.cwd(), // {String} dir where stats files are written; default current working dir
* csv: true, // {Boolean} of `true` output csv to filesystem; default `true`
* sortkey: 'total' // {String} key to reverse sort (total, average, max, min)
**Returns**: `String`, filename of csv file
### data
The data object where the statistics for each function are stored
**Example**
```js
{ './example.js:16:19:mwG':
{ name: './example.js:16:19:mwG', // file, line, column and name of function called
count: 3, // number of function calls
total: 6389, // time in nanoseconds
min: 826,
max: 2923 },
'./example.js:14:18:mw':
{ name: './example.js:14:18:mw',
count: 2,
total: 1662,
min: 742,
max: 920 } }
```
## Contribution and License Agreement
If you contribute code to this project, you are implicitly allowing your
code to be distributed under the MIT license. You are also implicitly
verifying that all code is your original work or correctly attributed
with the source of its origin and licence.
## License
Copyright (c) 2015 commenthol (MIT License)
See [LICENSE][] for more info.
## References
* [connect-composer][connect-composer]
* [LICENSE][LICENSE]
[LICENSE]: ./LICENSE
[connect-composer]: https://github.com/commenthol/connect-composer