Installation
Please follow the installation guide first, when adding a new application to AppSignal.
Requirements
Before you can compile the AppSignal package, make sure the build/compilation tools are installed for your system. Please check the Supported Operating Systems page for any system dependencies that may be required.
Installation
First, sign up for an AppSignal account and run our automated install tool, which will install @appsignal/nodejs
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
:
npm install --save @appsignal/nodejs yarn add @appsignal/nodejs
Alternatively, you can manually add the @appsignal/nodejs
package to your package.json
. Then, run yarn install
/npm install
.
// package.json { "name": "my-app", "dependencies": { "@appsignal/nodejs": "^3.0.0" } }
Create an appsignal.cjs
file to require and configure AppSignal. This file may also be placed in another location, like in the src/
directory. For more information about the configuration, see our configuration section.
// appsignal.cjs const { Appsignal } = require("@appsignal/nodejs"); new Appsignal({ active: true, name: "<YOUR APPLICATION NAME>", pushApiKey: "<YOUR API KEY>", // Note: renamed from `apiKey` in version 2.2.5 });
Now, you can run your application like you normally would, but use the --require
flag to load AppSignal's instrumentation before any other library:
node --require './appsignal.cjs' index.js
We recommend adding the --require
flag to any script that starts your app:
{ "scripts": { "server": "node --require ./appsignal.cjs index.js" } }
You can also use the --require
flag with tools such as ts-node
and nodemon
.
Import AppSignal Client
The AppSignal client is accessed from the globally exported Appsignal.client
object.
To use features like custom metrics, you must first import the AppSignal client:
import { Appsignal } from "@appsignal/nodejs"; // or: const { Appsignal } = require("@appsignal/nodejs"); const client = Appsignal.client;
Adding integrations
AppSignal supports several libraries and frameworks with additional packages, such as Express, Koa, Next.js and more. Additional installation instructions for these packages can be found in the Node.js integrations section.
Uninstalling AppSignal for Node.js
Uninstall AppSignal from your app by following the steps below. When these steps are completed your app will no longer send data to the AppSignal servers.
-
Run
npm uninstall @appsignal/nodejs
/yarn remove @appsignal/nodejs
to uninstall the AppSignal for Node.js integration, or delete the line within thedependencies
block of your application'spackage.json
file referencing the@appsignal/nodejs
package. -
Run
npm install
oryarn install
to update yourpackage.lock
/yarn.lock
with the removed packages state. -
Remove any AppSignal configuration from your app.
-
Commit, deploy and restart your app.
- This will make sure the AppSignal servers won't continue to receive data from your app.
-
Finally, remove the app on AppSignal.com.
Stop The AppSignal Client
AppSignal will stop automatically when your application or machine stops running. However, if you want to stop the AppSignal manually you can run the following command:
import { Appsignal } from "@appsignal/nodejs"; // or: const { Appsignal } = require("@appsignal/nodejs"); Appsignal.client.stop();