@appsignal/nodejs

@appsignal/nodejs

The core AppSignal for Node.js library.

See also the mono repo README for more information.

Installation

First, sign up for an AppSignal account and run our automated install tool, which will install @appsignal/nodejs and any relevant integrations to your project:

npx @appsignal/cli install

You can also skip the automated tool and add @appsignal/nodejs to your package.json on the command line with npm/yarn:

yarn add @appsignal/nodejs
npm install --save @appsignal/nodejs

Alternatively, you can manually add the @appsignal/nodejs package to your package.json. Then, run yarn install/npm install.

Installing the AppSignal for Node.js integration builds a native extension. In order to compile it, macOS users will need to install the Xcode Developer Tools. Linux users will need the dependencies outlined here. Windows is not supported.

You can then import and use the package in your bundle:

const { Appsignal } = require("@appsignal/nodejs");

const appsignal = new Appsignal({
  active: true,
  name: "<YOUR APPLICATION NAME>"
  apiKey: "<YOUR API KEY>"
});

// ...all the rest of your code goes here!

In order to auto-instrument modules, the Appsignal module must be both required and initialized before any other package.

Changelog

2.0.0

• f7acf83 major - Drop support for Node.js 10 and 11. These are unmaintained versions of Node.js.
• patch - Update @appsignal/nodejs-ext dependency to 2.0.0.