Cloud Debugger è deprecato e verrà chiuso il 31 maggio 2023. Per ulteriori informazioni, consulta la pagina relativa ai ritiri e alle note di rilascio.

Configurazione di Cloud Debugger per Node.js

Panoramica

In questa pagina viene spiegato come configurare il tuo ambiente e la tua applicazione Node.js per utilizzare Cloud Debugger. Per alcuni ambienti, devi specificare esplicitamente l'ambito di accesso per consentire all'agente Cloud Debugger di inviare i dati. Ti consigliamo di impostare l'ambito di accesso più ampio possibile e quindi utilizzare Identity and Access Management per limitare l'accesso. In linea con questa best practice, imposta l'ambito di accesso su tutte le API Cloud con l'opzione cloud-platform.

Versioni linguistiche degli ambienti di calcolo

Cloud Debugger è disponibile per Node.js 9 e versioni successive nei seguenti ambienti di calcolo:

Ambiente standard di App Engine Ambiente flessibile di App Engine Compute Engine Google Kubernetes Engine Cloud Run Cloud Run for Anthos VM e container in esecuzione altrove Cloud Functions

Configurazione di Cloud Debugger

Per configurare Cloud Debugger, completa le seguenti attività:

  1. Verifica che l'API Cloud Debugger sia abilitata per il tuo progetto.

  2. Installa e configura Debugger nell'ambiente di calcolo che stai utilizzando.

  3. Seleziona il tuo codice sorgente.

Verifica dell'abilitazione dell'API Cloud Debugger

Per iniziare a utilizzare Cloud Debugger, assicurati che l'API Cloud Debugger sia abilitata. Cloud Debugger è abilitato per impostazione predefinita per la maggior parte dei progetti.
Abilita l'API Cloud Debugger

Snapshot e punti di log canary

Per impedire il caricamento simultaneo di snapshot e punti di log in tutte le istanze in esecuzione, causando potenzialmente la rimozione del job a causa di un bug potenziale dell'agente Debugger, abilita la modalità canary per l'agente Debugger. Quando la modalità canary è abilitata, uno snapshot o un punto di log viene applicato a un sottoinsieme di istanze in esecuzione e Debugger verifica che l'istantanea o il punto di log non influisca negativamente su tali istanze. Al termine della verifica, lo snapshot o il punto di log viene applicato a tutte le istanze.

Per informazioni su come utilizzare Debugger in modalità canary, consulta le pagine relative a Debug snapshot e Debug punti di log.

Attivazione di snapshot e punti di log canary

Quando installi la versione più recente dell'agente Debugger, puoi scegliere di attivare o disattivare la versione canary. La versione canary è disattivata per impostazione predefinita.

Quando attivare snapshot e punti di log canary

Per proteggere i carichi di lavoro di deployment e critici per la produzione, abilita la versione canary durante il debug di questi carichi di lavoro.

Se hai una singola istanza, puoi eseguire il debug con la versione canary, ma l'istanza singola viene eseguita senza eliminare lo snapshot o il punto di log.

Quando non attivare snapshot canary e punti di log

Non attivare la versione canary su carichi di lavoro che hanno un tempo di esecuzione inferiore a 40 secondi, ad esempio i job che utilizzano Cloud Functions.

Non attivare la versione canary se vuoi un ciclo di attivazione degli snapshot più veloce.

Per configurare l'agente Debugger in modo che non esegua snapshot canary e punti di log, consulta le istruzioni di installazione per la piattaforma Google Cloud che stai utilizzando.

App Engine

  1. Usa npm per installare il pacchetto:

    npm install --save @google-cloud/debug-agent
    
  2. Attiva l'agente nella parte superiore dello script principale o dell'app della tua app (ma dopo @google/cloud-trace se lo utilizzi anche):

    Per eseguire il debug con la versione canary attivata:

    require('@google-cloud/debug-agent').start({serviceContext: {enableCanary: true}});
    

    Per eseguire il debug con la versione canary non abilitata, imposta enableCanary su false:

    require('@google-cloud/debug-agent').start({serviceContext: {enableCanary: false}});
    

Il debugger è ora pronto per l'utilizzo con l'app.

Per fare in modo che la pagina Debug nella console mostri automaticamente il codice sorgente corrispondente all'applicazione di cui è stato eseguito il deployment, consulta la sezione Selezionare automaticamente il codice sorgente.

Google Kubernetes Engine

GCLOUD

Per attivare Debugger utilizzando gcloud, completa i seguenti passaggi:

  1. Crea il cluster con uno dei seguenti ambiti di accesso:

    • https://www.googleapis.com/auth/cloud-platform concede al cluster l'accesso a tutte le API di Google Cloud.

    • https://www.googleapis.com/auth/cloud_debugger concede al cluster l'accesso solo all'API Debugger. Utilizza questo ambito di accesso per proteggere la sicurezza del tuo cluster.

    gcloud container clusters create example-cluster-name \
           --scopes=https://www.googleapis.com/auth/cloud_debugger
    
  2. Aggiungi la seguente riga al tuo Dockerfile per aggiungere l'agente Debugger:

    RUN  npm install --save @google-cloud/debug-agent
    
  3. Attiva l'agente nella parte superiore dello script principale o dell'app della tua app (ma dopo @google/cloud-trace se lo utilizzi anche):

    Per eseguire il debug con la versione canary attivata:

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

    Per eseguire il debug con la versione canary non abilitata, imposta enableCanary su false:

    enableCanary: false
    

    Dove:

    • SERVICE è un nome della tua app, ad esempio MyApp, Backend o Frontend.
    • VERSION è una versione, ad esempio v1.0, build_147 o v20170714.

    Ti consigliamo di impostarle dalle variabili di ambiente per non dover modificare il codice sorgente con ogni deployment.

Il debugger è ora pronto per l'utilizzo quando esegui il deployment della tua app containerizzata.

Per fare in modo che la pagina Debug nella console mostri automaticamente il codice sorgente corrispondente all'applicazione di cui è stato eseguito il deployment, consulta la sezione Selezionare automaticamente il codice sorgente.

CONSOLE

Per abilitare Debugger utilizzando Google Cloud Console, procedi nel seguente modo:

  1. Nella sezione Pool di nodi, seleziona Sicurezza, quindi seleziona Imposta l'accesso per ogni API.

  2. Abilita Debugger.

    L'API Debugger è abilitata per il cluster.

  3. (Facoltativo) Seleziona Consenti l'accesso completo a tutte le API Cloud.

  4. Aggiungi la seguente riga al tuo Dockerfile per aggiungere l'agente Debugger:

        RUN  npm install --save @google-cloud/debug-agent
    
  5. Attiva l'agente nella parte superiore dello script principale o dell'app della tua app (ma dopo @google/cloud-trace se lo utilizzi anche):

    Per eseguire il debug con la versione canary attivata:

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

    Per eseguire il debug con la versione canary non abilitata, imposta enableCanary su false:

    enableCanary: false
    

    Dove:

    • SERVICE è un nome della tua app, ad esempio MyApp, Backend o Frontend.
    • VERSION è una versione, ad esempio v1.0, build_147 o v20170714.

    Ti consigliamo di impostarle dalle variabili di ambiente per non dover modificare il codice sorgente con ogni deployment.

Compute Engine

  1. Assicurati che le istanze di Compute Engine vengano create con l'opzione ambito di accesso Consenti l'accesso completo a tutte le API Cloud o che dispongono di uno dei seguenti ambiti di accesso:

    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud_debugger
  2. Usa npm per installare il pacchetto:

    npm install --save @google-cloud/debug-agent
    
  3. Attiva l'agente nella parte superiore dello script principale o dell'app della tua app (ma dopo @google/cloud-trace se lo utilizzi anche):

    Per eseguire il debug con la versione canary attivata:

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

    Per eseguire il debug con la versione canary non abilitata, imposta enableCanary su false:

    enableCanary: false
    

    Dove:

    • SERVICE è un nome della tua app, ad esempio MyApp, Backend o Frontend.
    • VERSION è una versione, ad esempio v1.0, build_147 o v20170714.

    Ti consigliamo di impostarle dalle variabili di ambiente per non dover modificare il codice sorgente con ogni deployment.

Il debugger è ora pronto per l'utilizzo con l'app.

Per fare in modo che la pagina Debug nella console mostri automaticamente il codice sorgente corrispondente all'applicazione di cui è stato eseguito il deployment, consulta la sezione Selezionare automaticamente il codice sorgente.

Cloud Run e Cloud Run for Anthos

  1. Usa npm per installare il pacchetto:

    npm install --save @google-cloud/debug-agent
    
  2. Attiva l'agente nella parte superiore dello script o del punto di accesso principale dell'app (ma dopo @google/cloud-trace se lo utilizzi anche):

    Per eseguire il debug con la versione canary attivata:

    require('@google-cloud/debug-agent').start({serviceContext: {enableCanary: true}});
    

    Per eseguire il debug con la versione canary non abilitata, imposta enableCanary su false:

    enableCanary: false
    

    Il debugger è ora pronto per l'utilizzo quando esegui il deployment dell'app.

Locale e altrove

  1. Usa npm per installare il pacchetto:

    npm install --save @google-cloud/debug-agent
    
  2. Scarica le credenziali dell'account di servizio.

    Per utilizzare l'agente Cloud Debugger per Node.js su macchine non ospitate da Google Cloud, l'agente deve utilizzare le credenziali di un account di servizio Google Cloud per eseguire l'autenticazione con il servizio Cloud Debugger.

    Utilizza la pagina Account di servizio della console per creare un file delle credenziali per un account di servizio esistente o nuovo. L'account di servizio deve avere almeno il ruolo Cloud Debugger Agent.

  3. Configura e abilita l'agente con le credenziali scaricate:

    Per eseguire il debug con la versione canary attivata:

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

    Per eseguire il debug con la versione canary non abilitata, imposta enableCanary su false:

    enableCanary: false
    

    Dove:

    • SERVICE è un nome della tua app, ad esempio MyApp, Backend o Frontend.
    • VERSION è una versione, ad esempio v1.0, build_147 o v20170714.

    Ti consigliamo di impostarle dalle variabili di ambiente per non dover modificare il codice sorgente con ogni deployment.

Il debugger è ora pronto per l'utilizzo con l'app.

Nella pagina Debug nella console possono essere visualizzati i file di origine locali, senza caricamento, per lo sviluppo locale. Consulta Selezione manuale del codice sorgente.