Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uber-archive/express-statsd
Statsd route monitoring middleware for connect/express
https://github.com/uber-archive/express-statsd
Last synced: about 1 month ago
JSON representation
Statsd route monitoring middleware for connect/express
- Host: GitHub
- URL: https://github.com/uber-archive/express-statsd
- Owner: uber-archive
- License: mit
- Archived: true
- Created: 2014-01-15T20:10:22.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2020-03-18T21:24:58.000Z (over 4 years ago)
- Last Synced: 2024-07-12T14:24:49.680Z (2 months ago)
- Language: JavaScript
- Size: 13.7 KB
- Stars: 127
- Watchers: 2,244
- Forks: 21
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# express-statsd [](https://travis-ci.org/uber/express-statsd)
(This project is deprecated and not maintained.)
[StatsD](https://github.com/etsy/statsd/) route monitoring middleware for
[Connect](https://github.com/senchalabs/connect)/[Express](https://github.com/visionmedia/express).
This middleware can be used either globally or on a per-route basis (preferred)
and sends status codes and response times to StatsD.
## Installation
``` bash
npm install express-statsd
```
## Usage
An example of an express server with express-statsd:
``` js
var express = require('express');
var expressStatsd = require('express-statsd');
var app = express();
app.use(expressStatsd());
app.get('/', function (req, res) {
res.send('Hello World!');
});
app.listen(3000);
```
By default, the middleware will send `status_code` and `response_time` stats
for all requests. For example, using the created server above and a request to
`http://localhost:3000/`, the following stats will be sent:
```
status_code.200:1|c
response_time:100|ms
```
### Per route example
However, it's **highly recommended** that you set `req.statsdKey` which
will be used to namespace the stats. Be aware that stats will only be logged
once a response has been sent; this means that `req.statsdKey` can be
set even after the express-statsd middleware was added to the chain. Here's an
example of a server set up with a more specific key:
``` js
var express = require('express');
var expressStatsd = require('express-statsd');
var app = express();
function statsd (path) {
return function (req, res, next) {
var method = req.method || 'unknown_method';
req.statsdKey = ['http', method.toLowerCase(), path].join('.');
next();
};
}
app.use(expressStatsd());
app.get('/', statsd('home'), function (req, res) {
res.send('Hello World!');
});
app.listen(3000);
```
A GET request to `/` on this server would produce the following stats:
```
http.get.home.status_code.200:1|c
http.get.home.response_time:100|ms
```
### Plain http example
This module also works with any `http` server
```js
var http = require('http');
var expressStatsd = require('express-statsd');
var monitorRequest = expressStatsd();
http.createServer(function (req, res) {
monitorRequest(req, res);
// do whatever you want, framework, library, router
res.end('hello world');
}).listen(3000);
```
## Options
``` js
expressStatsd(options);
```
- **options** `Object` - Container for settings
- **client** `Object` - The statsd client. Defaults to [lynx](https://github.com/dscape/lynx)
with host set to `127.0.0.1` and port set to `8125`.
- **requestKey** `String` - The key on the `req` object at which to grab
the key for the statsd logs. Defaults to `req.statsdKey`.