Node.js HTTP Request Metrics Client

Common errors

• ReferenceError: require is not defined in ES module scope

  cause Attempting to use `require('http-measuring-client')` in a file that is treated as an ES module (e.g., because of `"type": "module"` in `package.json` or `.mjs` extension).
  fix Rename your file to `.cjs`, or change your `package.json`'s `type` field to `"commonjs"`. Alternatively, use `import { createRequire } from 'module'; const require = createRequire(import.meta.url); const httpMeasuringClient = require('http-measuring-client');` if you must use it within an ESM file.

• TypeError: http.get is not a function (or similar 'not a function' error on http methods)

  cause This error can occur if the `http-measuring-client` is not correctly initialized with a valid `http` module, or if a global monkey-patching attempt failed or was overwritten.
  fix Ensure you are calling `httpMeasuringClient.create()` or `httpMeasuringClient.createSecure()` and assigning the result to a variable that you then use for making requests (e.g., `const http = httpMeasuringClient.create(); http.get(...)`). Verify no other module is interfering with the `http` object.

Warnings

• breaking The `http-measuring-client` package is abandoned and has not been updated since 2014. It is unlikely to be compatible with recent Node.js versions, especially those introducing significant changes to the `http` module or new APIs like `fetch` and `http2`. Using unmaintained packages poses security risks and may lead to unexpected behavior.
  Fix: Consider using modern, actively maintained HTTP client libraries with built-in or plugin-based metric collection, such as `axios` with interceptors, `node-fetch` with custom agents, or OpenTelemetry integrations for Node.js.
• gotcha The package is CommonJS-only. Attempting to use `import` statements (ES modules) will result in a `ReferenceError: require is not defined` or similar errors in an ES module context. It must be consumed via `require()`.
  Fix: Ensure your project is configured for CommonJS, or use `const httpMeasuringClient = require('http-measuring-client');` in an ES module file to import it if your Node.js version supports mixing CJS and ESM.
• gotcha The documentation explicitly states that monkey-patching the global `http` module using `.mixin(http)` is possible but 'not recommended'. This approach can lead to unforeseen side effects, conflicts with other modules, and make debugging difficult due to altering global behavior.
  Fix: Prefer creating and injecting `http-measuring-client` instances into specific HTTP client libraries (like `request.defaults({ httpModules: { 'http:': http } })`) rather than modifying global modules.

Install

• npm install http-measuring-client npm
• yarn add http-measuring-client yarn
• pnpm add http-measuring-client pnpm

Imports

• create
  wrong:

  import { create } from 'http-measuring-client';

  correct:

  const httpMeasuringClient = require('http-measuring-client');
  const http = httpMeasuringClient.create();

  This package is CommonJS only and does not support ES module `import` syntax.
• createSecure
  wrong:

  import { createSecure } from 'http-measuring-client';

  correct:

  const httpMeasuringClient = require('http-measuring-client');
  const https = httpMeasuringClient.createSecure();

  Used for instrumenting the Node.js native `https` module. CommonJS only.
• mixin
  wrong:

  import { mixin } from 'http-measuring-client';

  correct:

  const httpMeasuringClient = require('http-measuring-client');
  httpMeasuringClient.mixin(require('http'));

  Allows monkey-patching the global Node.js `http` module, though the documentation advises against this approach. CommonJS only.

Quickstart

This example demonstrates how to create a measuring HTTP client, listen for 'stat' events to log detailed timing information, and make both HTTP and HTTPS requests.

const httpMeasuringClient = require('http-measuring-client');
const http = httpMeasuringClient.create();

http.on('stat', (parsedUri, stats) => {
  console.log(`Request to ${parsedUri.href} completed.`);
  console.log(`Total Time: ${stats.totalTime}ms`);
  console.log(`Connection Time: ${stats.connectionTime}ms`);
  console.log(`Processing Time: ${stats.processingTime}ms`);
  console.log(`Transmitting Time: ${stats.transmittingTime}ms`);
});

// Make an HTTP GET request and collect stats
http.get('http://google.com', (response) => {
  let data = '';
  response.on('data', (chunk) => {
    data += chunk;
  });
  response.on('end', () => {
    console.log('Response from google.com received and ended.');
    // console.log('Response body snippet:', data.substring(0, 100) + '...');
  });
}).on('error', (err) => {
  console.error('Error during HTTP request:', err.message);
});

// Example with an HTTPS request (requires a different client instance)
const https = httpMeasuringClient.createSecure();
https.get('https://example.com', (response) => {
  response.on('data', () => {});
  response.on('end', () => {
    console.log('Response from example.com received.');
  });
}).on('error', (err) => {
  console.error('Error during HTTPS request:', err.message);
});