https://github.com/saintedlama/express-req-metrics

Express middleware to collect request metrics and pass request metrics to a processing function.
https://github.com/saintedlama/express-req-metrics

Last synced: 2 months ago
JSON representation

Express middleware to collect request metrics and pass request metrics to a processing function.

• Host: GitHub
• URL: https://github.com/saintedlama/express-req-metrics
• Owner: saintedlama
• Created: 2015-05-07T11:42:56.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2017-05-31T21:38:45.000Z (over 7 years ago)
• Last Synced: 2024-10-12T12:25:40.979Z (3 months ago)
• Language: JavaScript
• Size: 13.7 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 28
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# express-req-metrics

[![Build Status](https://travis-ci.org/saintedlama/express-req-metrics.svg?branch=master)](https://travis-ci.org/saintedlama/express-req-metrics)

[![Coverage Status](https://coveralls.io/repos/github/saintedlama/express-req-metrics/badge.svg?branch=master)](https://coveralls.io/github/saintedlama/express-req-metrics?branch=master)

Express middleware to collect request metrics and pass request metrics to a processing function.

## Installation

    npm install express-req-metrics

## Usage

```javascript

var express = require('express');

var requestMetrics = require('express-req-metrics');

var app = express();

app.use(requestMetrics(function(req, res, metrics) {

  console.log(metrics);

}));

```

## Metrics

Metrics provided by `express-req-metrics`

```javascript

{ 

  url: '/',

  method: 'GET',

  route: '/',

  status: 200,

  responseTime: 7.499312,

  referrer: undefined,

  remoteAddress: '::ffff:127.0.0.1',

  remoteUser: '-',

  httpVersion: '1.1',

  userAgent: 'node-superagent/0.21.0',

  startTime: Thu May 07 2015 13:22:39 GMT+0200 (W. Europe Daylight Time),

  error: null 

}

```

route is set to route.path only if a route handler processed the request

## Using express-req-metrics together with bunyan

```javascript

// logger setup

var bunyan = require('bunyan');

var logger = bunyan.createLogger({

  name : 'demo',

  streams: [

    { path : './logs/requests.log' },

    { stream : process.stdout }

  ]

});

// express setup

var express = require('express');

var requestMetrics = require('express-req-metrics');

var app = express();

app.use(requestMetrics(function(req, res, metrics) {

  logger.info(metrics);

}));

```