Zum Hauptinhalt springen
Bitte folgen Sie zuerst dem Installationsleitfaden, wenn Sie eine neue Anwendung zu AppSignal hinzufügen.

​
Anforderungen

Bevor Sie das AppSignal-Paket kompilieren können, stellen Sie sicher, dass die Build-/Kompilierungswerkzeuge für Ihr System installiert sind. Bitte prüfen Sie die Seite Unterstützte Betriebssysteme auf eventuell erforderliche Systemabhängigkeiten.

​
Installation

Registrieren Sie sich zunächst für ein AppSignal-Konto. Installieren Sie dann AppSignal, indem Sie den Anweisungen für Ihren Paketmanager folgen.

​
Mit npm

npm install @appsignal/nodejs
Es ist auch möglich, das @appsignal/nodejs-Paket manuell zu Ihrer package.json hinzuzufügen. Führen Sie dann npm install aus. 
{
  "name": "my-app",
  "dependencies": {
    "@appsignal/nodejs": "^3.0.0"
  }
}
Erstellen Sie eine appsignal.cjs-Datei, um AppSignal zu requiren und zu konfigurieren. Diese Datei kann auch an einem anderen Ort platziert werden, z. B. im Verzeichnis src/. Weitere Informationen zur Konfiguration finden Sie in unserem Konfigurationsabschnitt. 
// appsignal.cjs
const { Appsignal } = require("@appsignal/nodejs");

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

​
Mit pnpm

pnpm unterdrückt standardmäßig Lifecycle-Skripte für Abhängigkeiten. Das @appsignal/nodejs-Paket verlässt sich auf ein install-Lifecycle-Skript, um seine native Erweiterung herunterzuladen und zu kompilieren. Ohne dieses wird die Erweiterung nicht geladen und AppSignal meldet keine Daten. Um das Paket zu installieren und sein Lifecycle-Skript ausführen zu lassen: 
pnpm --allow-build=@appsignal/nodejs add @appsignal/nodejs

​
Den AppSignal-Client requiren

Jetzt können Sie Ihre Anwendung wie gewohnt starten, aber verwenden Sie das Flag --require, um die Instrumentierung von AppSignal vor jeder anderen Bibliothek zu laden: 
node --require './appsignal.cjs' index.js
Wir empfehlen, das Flag --require zu jedem Skript hinzuzufügen, das Ihre App startet: 
{
  "scripts": {
    "server": "node --require ./appsignal.cjs index.js"
  }
}
Sie können das Flag --require auch mit Tools wie ts-node und nodemon verwenden. Wenn Sie ein Wrapper-CLI wie nest start oder fastify start zum Starten Ihrer Anwendung verwenden, nutzen Sie die Umgebungsvariable NODE_OPTIONS, um das Flag an die Node.js-Laufzeit zu übergeben: 
NODE_OPTIONS='--require ./appsignal.cjs' nest start
Damit die AppSignal-Integration korrekt funktioniert, muss die Datei appsignal.cjs vor allen anderen Abhängigkeiten required werden.

​
TypeScript-Unterstützung

AppSignal ist vollständig mit TypeScript kompatibel. Wenn Sie eine kompilierte TypeScript-Anwendung mit node ausführen, empfehlen wir die Verwendung des Node.js-Flags --enable-source-maps, damit Fehler-Backtraces in AppSignal auf Stellen im ursprünglichen TypeScript-Code verweisen: 
node --enable-source-maps --require './appsignal.cjs' dist/src/main.js
Wenn Sie ein Wrapper-CLI wie nest start oder fastify start zum Starten Ihrer Anwendung verwenden, nutzen Sie die Umgebungsvariable NODE_OPTIONS, um das Flag an die Node.js-Laufzeit zu übergeben: 
NODE_OPTIONS='--enable-source-maps --require ./appsignal.cjs' nest start

​
AppSignal-Client importieren

Auf den AppSignal-Client wird über das global exportierte Objekt Appsignal.client zugegriffen. Um Funktionen wie benutzerdefinierte Metriken zu verwenden, müssen Sie zuerst den AppSignal-Client importieren: 
import { Appsignal } from "@appsignal/nodejs";
// or: const { Appsignal } = require("@appsignal/nodejs");

const client = Appsignal.client;

​
Integrationen hinzufügen

AppSignal unterstützt mehrere Bibliotheken und Frameworks mit zusätzlichen Paketen, wie Express, Koa, Next.js und mehr. Zusätzliche Installationsanweisungen für diese Pakete finden Sie im Abschnitt Node.js-Integrationen.
📖 Fahren Sie mit unserem Installationsleitfaden fort.

​
AppSignal für Node.js deinstallieren

Deinstallieren Sie AppSignal aus Ihrer App, indem Sie die folgenden Schritte ausführen. Wenn diese Schritte abgeschlossen sind, sendet Ihre App keine Daten mehr an die AppSignal-Server.
  1. Führen Sie npm uninstall @appsignal/nodejs aus, um die AppSignal für Node.js-Integration zu deinstallieren, oder löschen Sie die Zeile innerhalb des dependencies-Blocks der package.json-Datei Ihrer Anwendung, die auf das Paket @appsignal/nodejs verweist.
  2. Führen Sie npm install aus, um Ihre package.lock mit dem Status der entfernten Pakete zu aktualisieren.
  3. Entfernen Sie alle AppSignal-Konfigurationen aus Ihrer App.
  4. Committen, deployen und starten Sie Ihre App neu.
    • Dadurch wird sichergestellt, dass die AppSignal-Server keine Daten mehr von Ihrer App empfangen.
  5. Entfernen Sie schließlich die App auf AppSignal.com.
📖 Fahren Sie mit unserem Deinstallationsleitfaden fort.

​
Den AppSignal-Client stoppen

AppSignal stoppt automatisch, wenn Ihre Anwendung oder Ihr Rechner nicht mehr läuft. Wenn Sie AppSignal jedoch manuell stoppen möchten, können Sie den folgenden Befehl ausführen: 
import { Appsignal } from "@appsignal/nodejs";
// or: const { Appsignal } = require("@appsignal/nodejs");

Appsignal.client.stop();