Naar hoofdinhoud gaan
Volg eerst de installatiegids wanneer u een nieuwe applicatie aan AppSignal toevoegt.

Vereisten

Voordat u het AppSignal-pakket kunt compileren, dient u ervoor te zorgen dat de build-/compilatietools voor uw systeem zijn geïnstalleerd. Controleer de pagina Ondersteunde besturingssystemen op eventuele systeemafhankelijkheden die vereist kunnen zijn.

Installatie

Maak eerst een AppSignal-account aan. Installeer AppSignal vervolgens door de instructies voor uw package manager te volgen.

Met npm

npm install @appsignal/nodejs
Het is ook mogelijk om het pakket @appsignal/nodejs handmatig toe te voegen aan uw package.json. Voer daarna npm install uit.
{
  "name": "my-app",
  "dependencies": {
    "@appsignal/nodejs": "^3.0.0"
  }
}
Maak een appsignal.cjs-bestand aan om AppSignal te requiren en te configureren. Dit bestand kan ook op een andere locatie worden geplaatst, bijvoorbeeld in de map src/. Voor meer informatie over de configuratie, zie ons configuratie-hoofdstuk.
// appsignal.cjs
const { Appsignal } = require("@appsignal/nodejs");

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

Met pnpm

pnpm onderdrukt standaard lifecycle scripts voor afhankelijkheden. Het pakket @appsignal/nodejs is afhankelijk van een install-lifecycle script om zijn native extensie te downloaden en te compileren. Zonder dit script wordt de extensie niet geladen en rapporteert AppSignal geen gegevens. Om het pakket te installeren en zijn lifecycle script toe te staan uit te voeren:
pnpm --allow-build=@appsignal/nodejs add @appsignal/nodejs

De AppSignal-client requiren

U kunt uw applicatie nu zoals gebruikelijk uitvoeren, maar gebruik de vlag --require om de instrumentatie van AppSignal te laden vóór elke andere bibliotheek:
node --require './appsignal.cjs' index.js
We raden aan de vlag --require toe te voegen aan elk script dat uw app start:
{
  "scripts": {
    "server": "node --require ./appsignal.cjs index.js"
  }
}
U kunt de vlag --require ook gebruiken met tools zoals ts-node en nodemon. Wanneer u een wrapper-CLI gebruikt, zoals nest start of fastify start, om uw applicatie te starten, gebruik dan de omgevingsvariabele NODE_OPTIONS om de vlag aan de Node.js-runtime door te geven:
NODE_OPTIONS='--require ./appsignal.cjs' nest start
Om de AppSignal-integratie correct te laten werken, moet het bestand appsignal.cjs worden gerequired vóór alle andere afhankelijkheden.

TypeScript-ondersteuning

AppSignal is volledig compatibel met TypeScript. Bij het uitvoeren van een gecompileerde TypeScript-applicatie met node, raden we aan om de Node.js-vlag --enable-source-maps te gebruiken, zodat fout-backtraces in AppSignal verwijzen naar locaties in de originele TypeScript-code:
node --enable-source-maps --require './appsignal.cjs' dist/src/main.js
Wanneer u een wrapper-CLI gebruikt, zoals nest start of fastify start, om uw applicatie te starten, gebruik dan de omgevingsvariabele NODE_OPTIONS om de vlag aan de Node.js-runtime door te geven:
NODE_OPTIONS='--enable-source-maps --require ./appsignal.cjs' nest start

De AppSignal-client importeren

De AppSignal-client is toegankelijk via het globaal geëxporteerde object Appsignal.client. Om functies zoals aangepaste metrics te gebruiken, moet u eerst de AppSignal-client importeren:
import { Appsignal } from "@appsignal/nodejs";
// or: const { Appsignal } = require("@appsignal/nodejs");

const client = Appsignal.client;

Integraties toevoegen

AppSignal ondersteunt diverse bibliotheken en frameworks met aanvullende pakketten, zoals Express, Koa, Next.js en meer. Aanvullende installatie-instructies voor deze pakketten zijn te vinden in het Node.js-integraties-hoofdstuk.
📖 Ga verder met onze installatiehandleiding.

AppSignal voor Node.js verwijderen

Verwijder AppSignal uit uw app door de onderstaande stappen te volgen. Wanneer deze stappen zijn voltooid, stuurt uw app geen gegevens meer naar de AppSignal-servers.
  1. Voer npm uninstall @appsignal/nodejs uit om de AppSignal voor Node.js-integratie te verwijderen, of verwijder de regel die naar het @appsignal/nodejs-pakket verwijst in het dependencies-blok van het package.json-bestand van uw applicatie.
  2. Voer npm install uit om uw package.lock bij te werken met de status van de verwijderde pakketten.
  3. Verwijder alle AppSignal-configuratie uit uw app.
  4. Commit, deploy en herstart uw app.
    • Dit zorgt ervoor dat de AppSignal-servers geen gegevens meer van uw app ontvangen.
  5. Tot slot, verwijder de app op AppSignal.com.
📖 Ga verder met onze verwijderingshandleiding.

De AppSignal-client stoppen

AppSignal stopt automatisch wanneer uw applicatie of machine stopt met draaien. Als u AppSignal echter handmatig wilt stoppen, kunt u het volgende commando uitvoeren:
import { Appsignal } from "@appsignal/nodejs";
// or: const { Appsignal } = require("@appsignal/nodejs");

Appsignal.client.stop();