response-time

What is response-time?

The response-time npm package is a middleware for Node.js that records the response time for HTTP requests. It is typically used with Express.js to measure the time taken to handle requests and send responses, which can be useful for performance monitoring and optimization.

What are response-time's main functionalities?

Basic Usage

This code demonstrates the basic usage of the response-time middleware in an Express.js application. It measures the response time for each HTTP request and adds it to the 'X-Response-Time' header.

const express = require('express');
const responseTime = require('response-time');

const app = express();

// Add the response-time middleware
app.use(responseTime());

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Custom Response Time Header

This code demonstrates how to use the response-time middleware with a custom header. Instead of the default 'X-Response-Time' header, it sets a custom header 'X-Custom-Response-Time' with the response time.

const express = require('express');
const responseTime = require('response-time');

const app = express();

// Add the response-time middleware with a custom header
app.use(responseTime((req, res, time) => {
  res.setHeader('X-Custom-Response-Time', `${time}ms`);
}));

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Logging Response Time

This code demonstrates how to log the response time for each request using the response-time middleware. It logs the HTTP method, URL, and response time to the console.

const express = require('express');
const responseTime = require('response-time');

const app = express();

// Add the response-time middleware with a logging function
app.use(responseTime((req, res, time) => {
  console.log(`Response time for ${req.method} ${req.url}: ${time}ms`);
}));

app.get('/', (req, res) => {
  res.send('Hello World!');
});

app.listen(3000, () => {
  console.log('Server is running on port 3000');
});

Other packages similar to response-time

morgan

Morgan is an HTTP request logger middleware for Node.js. It logs details about incoming requests, including response times, to the console or a file. While it provides more comprehensive logging capabilities compared to response-time, it is not specifically focused on measuring response times.

express-status-monitor

Express Status Monitor is a simple, self-hosted module based on Socket.io and Chart.js to report realtime server metrics for Express-based applications. It provides a web-based dashboard to monitor various metrics, including response times, making it more feature-rich compared to response-time.

prom-client

Prom-client is a Prometheus client for Node.js that allows you to instrument your application with custom metrics, including response times. It provides more flexibility and integration with Prometheus for monitoring and alerting, but requires more setup compared to response-time.

README

response-time

Response time middleware extracted from connect.

Installation

$ npm install response-time

API

var responseTime = require('response-time')

// time starts ticking from the moment req goes through the middleware
app.use(responseTime(5))

responseTime(digits)

Returns middleware that adds a X-Response-Time header to responses.

• digits - the fixed number of digits to include. (default: 3)

License

The MIT License (MIT)

Copyright (c) 2014 Jonathan Ong [e-mail]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.