Stackdriver Debugger für Node.js einrichten

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, den größtmöglichen 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.

Hinweise

Sorgen Sie zur Verwendung von Debugger dafür, dass die Debugger API aktiviert ist.
Debugger API aktivieren

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 Anwendung (aber gegebenenfalls nach @google/cloud-trace):

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

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

Wenn die Seite "Debugging" in der Cloud Console automatisch Quellcode anzeigen soll, der mit der bereitgestellten Anwendung übereinstimmt, beachten Sie die Hinweise unter Quellcode automatisch auswählen.

Google Kubernetes Engine

GCLOUD

Mit den folgenden Schritten aktivieren Sie Debugger mit gcloud:

  1. Erstellen Sie Ihren Cluster mit einem der folgenden Zugriffsbereiche:

    • https://www.googleapis.com/auth/cloud-platform gewährt Ihrem Cluster Zugriff auf alle Google Cloud APIs.

    • https://www.googleapis.com/auth/cloud_debugger gewährt Ihrem Cluster nur Zugriff auf die Debugger API. Verwenden Sie diesen Zugriffsbereich, um die Sicherheit Ihres Clusters zu härten.

    gcloud container clusters create example-cluster-name \
           --scopes=https://www.googleapis.com/auth/cloud_debugger
    
  2. Fügen Sie die folgende Zeile Ihrem Dockerfile hinzu, um den Debugger-Agent hinzuzufügen:

    RUN  npm install --save @google-cloud/debug-agent
    
  3. Aktivieren Sie den Agent am Anfang des Hauptskripts oder des Einstiegspunkts Ihrer Anwendung (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 Anwendung, z. B. MyApp, Backend oder Frontend.
    • VERSION ist eine Version, z. B. 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 einsatzbereit, wenn Sie Ihre containerisierte Anwendung bereitstellen.

Wenn die Seite "Debugging" in der Cloud Console automatisch Quellcode anzeigen soll, der mit der bereitgestellten Anwendung übereinstimmt, beachten Sie die Hinweise unter Quellcode automatisch auswählen.

CONSOLE

Führen Sie die folgenden Schritte aus, um Debugger mithilfe der Console zu aktivieren:

  1. Klicken Sie nach der Auswahl des Clustertyps im Bereich Node pools (Knotenpools) auf More options (Weitere Optionen):

    Optionen für Knotenpools

  2. Wählen Sie im Bereich Sicherheit eine der folgenden Optionen aus:

    • Uneingeschränkten Zugriff auf alle Cloud APIs zulassen.

    • Zugriff für jede API festlegen. Wählen Sie anschließend Aktiviert für Cloud Debugger aus.

Compute Engine

  1. Achten Sie darauf, 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 Anwendung (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 Anwendung, z. B. MyApp, Backend oder Frontend.
    • VERSION ist eine Version, z. B. 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 Anwendung.

Wenn die Seite "Debugging" in der Cloud Console automatisch Quellcode anzeigen soll, der mit der bereitgestellten Anwendung übereinstimmt, beachten Sie die Hinweise unter Quellcode automatisch auswählen.

Cloud Run und Cloud Run for Anthos in Google Cloud

  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 Anwendung (aber gegebenenfalls nach @google/cloud-trace):

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

    Der Debugger ist jetzt einsatzbereit, wenn Sie Ihre Anwendung bereitstellen.

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 Rechnern verwenden möchten, die nicht von Google Cloud gehostet werden, muss sich der Agent mithilfe der Anmeldedaten eines Google Cloud-Dienstkontos beim Stackdriver Debugger-Dienst authentifizieren.

    Verwenden Sie die Cloud Console-Seite "Dienstkonten", um eine Datei mit Anmeldedaten 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 Anwendung, z. B. MyApp, Backend oder Frontend.
    • VERSION ist eine Version, z. B. 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 Anwendung.

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