@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>"
  pushApiKey: "<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.

Extension

This package also contains the C++ extension, and the install script for the agent. The native extension is a bridge between the Node.js runtime and our agent.

Changelog

2.3.2

Changed

• 7a7e5c5 patch - Update the expected Span type in ScopeManager to Span from the @appsignal/nodejs package, rather than the NodeSpan from the @appsignal/types package. The type definition is the same, but now all Span types used by the Node.js integration are defined in the @appsigna/nodejs package.
• 7fc5e40 patch - Improve memory usage when extension is not initialized. It will no longer initialize a new empty Tracer object when the extension is not loaded or AppSignal is not active.
• 47a851b patch - Update @appsignal/types dependency to 3.0.0.

Removed

• 32d8054 patch - Remove the private function Span.toJSON. This wasn't previously marked as private, but it was.
• 178b49a patch - Do not ship the extension install script test files in the published package. Reduces the package size a tiny bit.
• 0af54b7 patch - Remove the unused experimental module.

Fixed

• 083a39a patch - Show errors in loading the extension when the @appsignal/nodejs module is required.
• afe221e patch - The minutely probes are now stopped when Appsignal.stop() is called. This fixes an issue where Jest tests would warn about asynchronous operations that remain pending after the tests.