Stackdriver Debugger für Node.js einrichten

Dies ist Release von Stackdriver Debugger-Agent für Node.js. auf nicht abwärtskompatible Weise geändert werden ist durch keine SLA oder Richtlinie zu veralteten Softwarefunktionen abgedeckt.

Hinweis: Stackdriver Debugger ist mit Node.js Version 6 und höher kompatibel. Wir empfehlen, die Langzeit-Supportversion zu verwenden.

Auf dieser Seite wird gezeigt, wie Sie Ihre Umgebung und Ihre Node.js-Anwendung für die Verwendung von Stackdriver Debugger konfigurieren. In einigen Umgebungen müssen Sie, damit der Stackdriver Debugger-Agent Daten senden kann, den Zugriffsbereich explizit angeben. Es wird empfohlen, einen möglichst breiten Zugriffsbereich festzulegen und anschließend den Zugriff mit Cloud Identity and Access Management einzuschränken. Geben Sie den Zugriffsbereich entsprechend dieser Best Practice für alle Cloud APIs mit der Option cloud-platform an.

App Engine

1. Installieren Sie das Paket mit npm:

   npm install --save @google-cloud/debug-agent
   

2. Aktivieren Sie den Agent am Anfang des Hauptskripts oder des Einstiegspunkts Ihrer App (aber gegebenenfalls nach @google/cloud-trace):

   require('@google-cloud/debug-agent').start();
   

Der Debugger ist jetzt bereit für die Verwendung mit Ihrer App.

Zur automatischen Anzeige des Quellcodes der bereitgestellten Anwendung auf der Seite "Fehlerbehebung" der GCP Console finden Sie entsprechende Informationen unter Quellcode automatisch auswählen.

Google Kubernetes Engine

1. Erstellen Sie Ihren Cluster mit einem der folgenden Zugriffsbereiche:
   • https://www.googleapis.com/auth/cloud-platform
   • https://www.googleapis.com/auth/cloud_debugger
   Hinweis: Sie können die Zugriffsbereiche eines Clusters nach der Erstellung nicht mehr ändern.

   So erstellen Sie einen Cluster mit gcloud:

   1. (Optional) Aktualisieren Sie gcloud auf die neueste Version:

      gcloud components update

   2. Legen Sie Ihre standardmäßige Projekt-ID fest:

      gcloud config set project [PROJECT_ID]

   3. Wenn Sie mit zonalen Clustern arbeiten, legen Sie Ihre standardmäßige Compute-Zone fest:

      gcloud config set compute/zone [COMPUTE_ZONE]

   4. Wenn Sie mit regionalen Clustern arbeiten, legen Sie Ihre standardmäßige Compute-Region fest:

      gcloud config set compute/region [COMPUTE_REGION]

   5. Führen Sie den Befehl zum Erstellen aus:

      gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

   Ausführliche Informationen zum Erstellen eines Clusters finden Sie unter Cluster erstellen.

2. Folgen Sie der Anleitung für Compute Engine.

Compute Engine

1. Stellen Sie sicher, dass Ihre Compute Engine-VM-Instanzen mit der Zugriffsbereichsoption Vollen Zugriff auf alle Cloud-APIs zulassen eingerichtet sind oder einen der folgenden Zugriffsbereiche haben:

   • https://www.googleapis.com/auth/cloud-platform
   • https://www.googleapis.com/auth/cloud_debugger

2. Installieren Sie das Paket mit npm:

   npm install --save @google-cloud/debug-agent
   

3. Aktivieren Sie den Agent am Anfang des Hauptskripts oder des Einstiegspunkts Ihrer App (aber gegebenenfalls nach @google/cloud-trace):

   require('@google-cloud/debug-agent').start({
     serviceContext: {
       service: 'SERVICE',
       version: 'VERSION'
     }
   });
   

   Dabei gilt:

   • SERVICE ist ein Name für Ihre App. Beispiel: MyApp, Backend oder Frontend
   • VERSION ist eine Version wie v1.0, build_147 oder v20170714.

   Wir empfehlen, diese über Umgebungsvariablen festzulegen, damit Sie den Quellcode nicht bei jeder Bereitstellung ändern müssen.

Der Debugger ist jetzt bereit für die Verwendung mit Ihrer App.

Unter Quellcode automatisch auswählen erfahren Sie, wie Sie auf der Seite "Fehlerbehebung" in der Cloud Platform Console automatisch die Dateien anzeigen lassen können, die dem Quellcode entsprechen.

Lokal und an anderer Stelle

1. Installieren Sie das Paket mit npm:

   npm install --save @google-cloud/debug-agent
   

2. Laden Sie Anmeldedaten für das Dienstkonto herunter.

   Wenn Sie den Stackdriver Debugger-Agent für Node.js auf Computern verwenden möchten, die nicht von der Google Cloud Platform gehostet werden, muss sich der Agent mithilfe der Anmeldedaten eines GCP-Dienstkontos beim Stackdriver Debugger-Dienst authentifizieren.

   Verwenden Sie die Seite "Dienstkonten" der Cloud Platform Console, um eine Anmeldedatendatei für ein bestehendes oder neues Dienstkonto zu erstellen. Das Dienstkonto muss mindestens die Rolle Stackdriver Debugger Agent haben.

3. Konfigurieren und aktivieren Sie den Agent mit den heruntergeladenen Anmeldedaten.

   require('@google-cloud/debug-agent').start({
     projectId: 'your-project-id',
     keyFilename: '/path/to/key.json',
     serviceContext: {
       service: 'SERVICE',
       version: 'VERSION'
     }
   });
   

   Dabei gilt:

   • SERVICE ist ein Name für Ihre App. Beispiel: MyApp, Backend oder Frontend
   • VERSION ist eine Version wie v1.0, build_147 oder v20170714.

   Wir empfehlen, diese über Umgebungsvariablen festzulegen, damit Sie den Quellcode nicht bei jeder Bereitstellung ändern müssen.

Der Debugger ist jetzt bereit für die Verwendung mit Ihrer App.

Auf der Seite "Fehlerbehebung" der GCP Console können die lokalen Quelldateien ohne Hochladen für die lokale Entwicklung angezeigt werden. Weitere Informationen finden Sie unter Quellcode manuell auswählen.

Hinweis: Code und Dokumentation des Debugger-Agents finden Sie auf GitHub.