@loadmill/node-recorder

Loadmill node-recorder

Users of Loadmill can use this node-recoder middleware to capture traffic in their express.js apps. Later they can generate and replay the recording as API tests.

Installation

Using npm:

npm install loadmill-node-recorder --save

Using yarn:

yarn add loadmill-node-recorder

API

Use expressRecorder middleware:

const { expressRecorder } = require('@loadmill/node-recorder');
const app = require('express')();
app.use(expressRecorder({ loadmillCode: process.env.LOADMILL_CODE }));

expressRecorder accepts options object - containing:

• loadmillCode - (REQUIRED). can be retrieved after creating a new application for recording.
• getUniqueId - (default = req.user.id). Optionally can pass a function to retrieve uniqueId per user. This id can be used for multiple recordings.
• notSecure - (default = false). Optionally you can make recorded traffic not be hashed.
• cookieExpiration - (default = 3 minutes = 3 * 60 * 1000). expressRecorder maintain cookie to define new recording session per uniqueId(user). More about split recording session.
• basePath - (default = https://dummy.domain). Define the protocol://host of your app.

Extended Example

app.use(expressRecorder({ 
   loadmillCode: process.env.LOADMILL_CODE,
   getUniqueId: (req) => req.user.id,
   notSecure: false, 
   cookieExpiration: 10 * 60 * 1000,
   basePath: 'https://loadmill.com'
}));

Learn More

• About Loadmill
• About Recordings