@appsignal/nodejs

AppSignal for Node.js

• AppSignal.com website
• Documentation
• Support

The core AppSignal for Node.js library.

Installation

Please follow our installation guide in our documentation.

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.

Development

Installation

This repository is a mono-managed repository. First install mono on your local machine by following the mono installation steps.

Then install the dependencies and prepare the project for development use using mono:

mono bootstrap

You can then run the following to start the compiler in watch mode.

npm run build:watch --parallel

You can also build the library without watching the directory:

mono build

Version management configuration is provided for asdf.

Testing

The tests for this library use Jest as the test runner. Once you've installed the dependencies, you can run the following command in the root of this repository to run the tests for all packages, or in the directory of a package to run only the tests pertaining to that package:

mono test

Contributing

Thinking of contributing to this repo? Awesome! 🚀

Please follow our Contributing guide in our documentation and follow our Code of Conduct.

Also, we would be very happy to send you Stroopwafels. Have look at everyone we send a package to so far on our Stroopwafels page.

Support

Contact us and speak directly with the engineers working on AppSignal. They will help you get set up, tweak your code and make sure you get the most out of using AppSignal.