themightypenguin / appsignal-nodejs

🟩 AppSignal for Node.js

AppSignal for Node.js

• AppSignal.com website
• Documentation
• Support

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. 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!

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

Development

Installation

This repository is a Lerna-managed monorepo, containing packages (located in the /packages directory) that map to separate npm modules.

To install the dependencies:

npm install
npx lerna bootstrap && npx lerna link

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

npm run build:watch

You can also build the library without watching the directory:

npm run build

Version management configuration is provided for volta and 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:

npm run test

Versioning

This repo uses Semantic Versioning (often referred to as semver). Each package in the repository is versioned independently from one another.

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.