statful-middleware-express
v2.0.4
Published
Express middleware to automatically register Statful metrics.
Downloads
8
Keywords
Readme
statful-middleware-express
A common pattern in expressjs/restify applications it to gather response times from all received requests, this middleware takes care of collecting common useful metrics automatically.
Installing
npm install --save statful-middleware-express statful-client
yarn add statful-middleware-express statful-client
Getting started
const express = require("express");
const Statful = require("statful-client");
const statfulMiddleware = require("statful-middleware-express");
const app = express();
const statful = new Statful({
/* statful configuration */
});
app.use(statfulMiddleware(statful));
app.listen(3000);
Configuration
Most of the configuration is done directly in the statful instance. You can read more about the available options directly from the Statful repository.
Default Metrics
By default, the follow metrics are collected, with the corresponding tags:
response_time
hostname
method
: GET, POST, PUT ...statusCode
: 200, 400, 404 ...statusCodeCategory
- informational
- success
- redirection
- client_error
- server_error
route
: Either the route handler's name, the route path orunknown_route
. e.g.:/users/:id?
Authors
License
statful-middleware-express is available under the MIT license. See the LICENSE file for more information.