@szmarczak/http-timer
Advanced tools
Package description
@szmarczak/http-timer is an npm package designed to measure the timing of HTTP requests. It provides detailed timing information for various phases of an HTTP request, such as DNS lookup, TCP connection, and response time. This can be useful for performance monitoring and debugging.
Measure HTTP request timings
This feature allows you to measure the timings of an HTTP request. The code sample demonstrates how to use the package to measure and log the timings of a GET request to 'http://example.com'.
const http = require('http');
const timer = require('@szmarczak/http-timer');
const request = http.get('http://example.com', response => {
timer(request);
response.on('end', () => {
console.log(request.timings);
});
});Detailed timing phases
This feature provides detailed timing information for different phases of an HTTP request. The code sample shows how to log the DNS lookup time, TCP connection time, time to first byte, download time, and total time for a GET request.
const http = require('http');
const timer = require('@szmarczak/http-timer');
const request = http.get('http://example.com', response => {
timer(request);
response.on('end', () => {
console.log('DNS Lookup Time:', request.timings.dns);
console.log('TCP Connection Time:', request.timings.tcp);
console.log('First Byte Time:', request.timings.firstByte);
console.log('Download Time:', request.timings.download);
console.log('Total Time:', request.timings.total);
});
});Axios is a popular HTTP client for Node.js and the browser. It supports request and response interceptors, automatic transforms for JSON data, and more. While it does not provide detailed timing information out of the box, it can be extended with interceptors to measure request timings.
Request is a simplified HTTP client for Node.js. It is known for its ease of use and flexibility. Although it does not natively support detailed timing information, it can be combined with other packages or custom code to achieve similar functionality.
Got is a lightweight and powerful HTTP request library for Node.js. It includes built-in support for retries, streams, and hooks. Got also provides detailed timing information similar to @szmarczak/http-timer, making it a strong alternative.
Readme
Timings for HTTP requests
Inspired by the request package.
NPM:
npm install @szmarczak/http-timer
Yarn:
yarn add @szmarczak/http-timer
Note:
- The measured events resemble Node.js events, not the kernel ones.
- Sending a chunk greater than
highWaterMarkwill result in invaliduploadandresponsetimings. You can avoid this by splitting the payload into smaller chunks.
import https from 'https';
import timer from '@szmarczak/http-timer';
const request = https.get('https://httpbin.org/anything');
timer(request);
request.once('response', response => {
response.resume();
response.once('end', () => {
console.log(response.timings); // You can use `request.timings` as well
});
});
// {
// start: 1572712180361,
// socket: 1572712180362,
// lookup: 1572712180415,
// connect: 1572712180571,
// upload: 1572712180884,
// response: 1572712181037,
// end: 1572712181039,
// error: undefined,
// abort: undefined,
// phases: {
// wait: 1,
// dns: 53,
// tcp: 156,
// request: 313,
// firstByte: 153,
// download: 2,
// total: 678
// }
// }
Returns: Object
Note: The time is a number representing the milliseconds elapsed since the UNIX epoch.
start - Time when the request started.socket - Time when a socket was assigned to the request.lookup - Time when the DNS lookup finished.connect - Time when the socket successfully connected.secureConnect - Time when the socket securely connected.upload - Time when the request finished uploading.response - Time when the request fired response event.end - Time when the response fired end event.error - Time when the request fired error event.abort - Time when the request fired abort event.phases
wait - timings.socket - timings.startdns - timings.lookup - timings.sockettcp - timings.connect - timings.lookuptls - timings.secureConnect - timings.connectrequest - timings.upload - (timings.secureConnect || timings.connect)firstByte - timings.response - timings.uploaddownload - timings.end - timings.responsetotal - (timings.end || timings.error || timings.abort) - timings.startIf something has not been measured yet, it will be undefined.
MIT
FAQs
Timings for HTTP requests
The npm package @szmarczak/http-timer receives a total of 9,457,884 weekly downloads. As such, @szmarczak/http-timer popularity was classified as popular.
We found that @szmarczak/http-timer demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Git dependencies in open source packages can introduce significant risks, including lack of version control, stability issues, dependency drift, and difficulty in auditing, making them potential targets for supply chain attacks.
Security News
Node.js has added experimental support for TypeScript, a move that highlights the growing importance of TypeScript in modern development.
Product
Check out what's new at Socket with our Product Changelog. It tracks all public-facing updates, improvements, and fixes so you can take full advantage of our features.