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
@appsignal/nodejs handmatig toe te voegen aan uw package.json. Voer daarna npm install uit.
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.
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:
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:
--require toe te voegen aan elk script dat uw app start:
--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:
TypeScript-ondersteuning
AppSignal is volledig compatibel met TypeScript. Bij het uitvoeren van een gecompileerde TypeScript-applicatie metnode, 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:
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:
De AppSignal-client importeren
De AppSignal-client is toegankelijk via het globaal geëxporteerde objectAppsignal.client.
Om functies zoals aangepaste metrics te gebruiken, moet u eerst de AppSignal-client importeren:
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.-
Voer
npm uninstall @appsignal/nodejsuit om de AppSignal voor Node.js-integratie te verwijderen, of verwijder de regel die naar het@appsignal/nodejs-pakket verwijst in hetdependencies-blok van hetpackage.json-bestand van uw applicatie. -
Voer
npm installuit om uwpackage.lockbij te werken met de status van de verwijderde pakketten. - Verwijder alle AppSignal-configuratie uit uw app.
-
Commit, deploy en herstart uw app.
- Dit zorgt ervoor dat de AppSignal-servers geen gegevens meer van uw app ontvangen.
- Tot slot, verwijder de app op AppSignal.com.
📖 Ga verder met onze verwijderingshandleiding.