@loadmill/node-recorder
v0.3.142
Published
Loadmill expressjs recorder middleware
Downloads
131
Readme
Loadmill node-recorder
Users of Loadmill can use node-recorder
middleware to capture traffic in their express.js apps. Later they can generate and replay the recording as API tests.
Setup Walkthrough
Go to Recordings App Setup and create a new application.
Copy Loadmill Tracking Id
and use it as loadmillCode
option value in expressRecorder
.
Installation
Using npm:
npm i @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.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 theprotocol://host
of your app.
Extended Example
app.use(expressRecorder({
loadmillCode: process.env.LOADMILL_CODE,
notSecure: false,
cookieExpiration: 10 * 60 * 1000,
basePath: 'https://loadmill.com'
}));
How do I debug?
Loadmill node-recorder uses the debug module internally, so you can set the DEBUG environment variable to loadmill:* to see all debugging, or select individual namespaces DEBUG=loadmill:node-recorder to constrain a bit.
Learn More
- About Loadmill
- About Recordings