express-hot-shots
StatsD route monitoring middleware for Connect/Express. This middleware can be used either globally or on a per-route basis (preferred) and sends status codes and response times to StatsD.
Forked from uber/express-statsd for usage in Spectrum.
Installation
npm install express-hot-shots
Usage
An example of an express server with express-hot-shots:
var express = ;var statsd = ;var app = ;app;app;app;
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-hot-shots middleware was added to the chain. Here's an
example of a server set up with a more specific key:
var express = ;var expressStatsd = ;var app = ;{return {var method = reqmethod || 'unknown_method';reqstatsdKey = 'http' method path;;};}app;app;app;
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
Tags
You can set the tags of the metrics with the req.statsdTags
property.
function statsd (path) { return function (req, res, next) { var method = req.method || 'unknown_method'; req.statsdKey = ['http', method.toLowerCase(), path].join('.'); req.statsdTags = { server: process.env.SERVER_NAME, } next(); };}
These will be sent with both the response time and status code metrics.
Plain http example
This module also works with any http
server
var http = ;var expressStatsd = ; var monitorRequest = ; http;
Options
;
- options
Object
- Container for settings- client
HotShots instance
- a custom hot shots instance - hotShots
Object
- The hotShots options if you don't want to provide your own instance - requestKey
String
- The key on thereq
object at which to grab the key for the statsd logs. Defaults toreq.statsdKey
.
- client