Menu

NestJS

This feature requires AppSignal for Node.js version 3.0.0 or higher.
This feature requires NestJS version 4.0.0 or higher.

Default instrumentations can be disabled via the disableDefaultInstrumentations config option. You can read more about how to configure this in our Configuration Options documentation.

The AppSignal for Node.js integration for NestJS.

Installation

NestJS is instrumented automatically by the AppSignal for Node.js package.

When calling nest start directly, you can use the NODE_OPTIONS environment variable to require it:

Shell
NODE_OPTIONS='--require ./appsignal.cjs' nest start

The start script references the appsignal.cjs file that was created when configuring AppSignal.

To use AppSignal from the npm commands generated when creating an application with the nest new command, modify the following scripts from the scripts section of your package.json file as follows:

package.json
{
  "scripts": {
    "start": "NODE_OPTIONS='--require ./appsignal.cjs' nest start",
    "start:dev": "NODE_OPTIONS='--require ./appsignal.cjs' nest start --watch",
    "start:debug": "NODE_OPTIONS='--require ./appsignal.cjs' nest start --debug --watch",
    "start:prod": "node --require ./appsignal.cjs dist/main"
  }
}

Features

The NestJS integration will send AppSignal a child span representing the execution time of each middleware, as well as a child span for the request handler.

The name of the controller class and method that handled the request will be used as the name of the action.

Any errors raised by your NestJS application will be reported to AppSignal.