Profilazione delle applicazioni Node.js

In questa pagina viene descritto come modificare l'applicazione Node.js per acquisire i dati di profilazione e fare in modo che i dati vengano inviati al progetto Google Cloud. Per informazioni generali sulla profilazione, consulta i concetti di profilazione.

Tipi di profilo per Node.js:

  • Heap
  • Tempo totale di esecuzione

Versioni del linguaggio Node.js supportate:

Versioni dell'agente di profilazione supportate:

  • È supportata la release più recente dell'agente. In generale, le release più vecchie di un anno non sono supportate. Ti consigliamo di usare la versione dell'agente rilasciata più di recente.

Sistemi operativi supportati:

  • Linux. La profilazione delle applicazioni Node.js è supportata per i kernel Linux la cui libreria C standard è implementata con glibc o con musl. Per informazioni sulla configurazione specifiche per i kernel Linux Alps, consulta Esecuzione su Linux Alps.

Ambienti supportati:

Abilitazione dell'API Profiler

Prima di utilizzare l'agente di profilazione, assicurati che l'API Profiler sottostante sia abilitata. Puoi controllare lo stato dell'API e abilitarla, se necessario, utilizzando Google Cloud CLI o la console Google Cloud:

Interfaccia a riga di comando gcloud

  1. Se non hai già installato Google Cloud CLI sulla tua workstation, consulta la documentazione di Google Cloud CLI.

  2. Esegui questo comando:

    gcloud services enable cloudprofiler.googleapis.com

Per maggiori informazioni, vedi gcloud services.

Console Google Cloud

  1. Attiva l'API richiesta.

    Abilita l'API

  2. Se viene visualizzato API abilitata, l'API è già abilitata. In caso contrario, fai clic sul pulsante Attiva.

Utilizzo di Cloud Profiler

In tutti gli ambienti supportati, puoi utilizzare Profiler installando il pacchetto @google-cloud/profiler, aggiungendo un'istruzione require all'applicazione ed eseguendo il deployment dell'applicazione secondo la normale modalità.

Prima di installare @google-cloud/profiler

Il pacchetto @google-cloud/profiler dipende da un modulo nativo. I file binari predefiniti per questo modulo nativo sono disponibili per Linux e Alpine Linux per i nodi 14 e 16. Non sono necessarie dipendenze aggiuntive. @google-cloud/profiler utilizza node-pre-gyp per determinare quale file binario predefinito installare.

Quando utilizzi @google-cloud/profiler su altri ambienti che non hanno programmi binari predefiniti, il modulo node-gyp viene utilizzato per creare programmi binari. Per informazioni sulle dipendenze necessarie per creare programmi binari con node-gyp, consulta la documentazione di installazione di node-gyp.

Installazione

Per installare la versione più recente di Cloud Profiler, segui questi passaggi:

    npm install --save @google-cloud/profiler

Se utilizzi anche l'agente Trace, quando modifichi l'applicazione, importa il pacchetto Profiler dopo il pacchetto dell'agente Trace (@google-cloud/trace-agent).

Compute Engine

Per Compute Engine, segui questi passaggi:

  1. Installa la versione più recente di Cloud Profiler:

    npm install --save @google-cloud/profiler

  2. Modifica il codice require dell'applicazione per creare un oggetto serviceContext che assegni a service il nome del servizio che viene profilato. Facoltativamente, puoi assegnare a version la versione del servizio da profilare. Per ulteriori informazioni su queste opzioni di configurazione, consulta Argomenti Nome servizio e versione:

    require('@google-cloud/profiler').start({
  serviceContext: {
    service: 'your-service',
    version: '1.0.0',
  },
});

GKE

Per GKE, segui questi passaggi:

  1. Modifica il tuo Dockerfile per installare il pacchetto Profiler:

    FROM node:10
...
RUN npm install @google-cloud/profiler

  2. Modifica il codice require dell'applicazione per creare un oggetto serviceContext che assegni a service il nome del servizio che viene profilato. Facoltativamente, puoi assegnare a version la versione del servizio da profilare. Per ulteriori informazioni su queste opzioni di configurazione, consulta Argomenti Nome servizio e versione:

    require('@google-cloud/profiler').start({
  serviceContext: {
    service: 'your-service',
    version: '1.0.0',
  },
});

App Engine

Per l'ambiente flessibile di App Engine e per l'ambiente standard di App Engine, il codice require è simile al seguente:

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

In App Engine, i parametri service e version derivano dall'ambiente, quindi non devi specificarli. Pertanto, non è necessario creare un oggetto serviceContext.

Analisi dei dati

Dopo che Profiler ha raccolto i dati, puoi visualizzarli e analizzarli utilizzando l'interfaccia di Profiler.

Nella console Google Cloud, vai alla pagina Profiler:

Vai a Profiler

Puoi trovare questa pagina anche utilizzando la barra di ricerca.

Argomenti per nome e versione del servizio

Quando carichi l'agente Profiler, specifichi un argomento service-name e un argomento facoltativo service-version per configurarlo.

Il nome del servizio consente a Profiler di raccogliere dati di profilazione per tutte le repliche di quel servizio. Il servizio profiler garantisce una frequenza di raccolta di un profilo al minuto, in media, per ciascun nome di servizio in ogni combinazione di versioni e zone del servizio.

Ad esempio, se hai un servizio con due versioni in esecuzione su repliche in tre zone, il profiler creerà una media di 6 profili al minuto per quel servizio.

Se utilizzi nomi di servizio diversi per le repliche, il servizio verrà profilato più spesso del necessario, con un overhead di conseguenza più elevato.

Quando selezioni il nome di un servizio:

  • Scegli un nome che rappresenti chiaramente il servizio nell'architettura dell'applicazione. La scelta del nome del servizio è meno importante se esegui un solo servizio o un'unica applicazione. È più importante se l'applicazione viene eseguita come un insieme di microservizi, ad esempio.

  • Assicurati di non utilizzare valori specifici del processo, ad esempio un ID di processo, nella stringa del nome del servizio.

  • La stringa del nome del servizio deve corrispondere a questa espressione regolare:

    ^[a-z0-9]([-a-z0-9_.]{0,253}[a-z0-9])?$

Una buona linea guida è usare una stringa statica come imageproc-service come nome del servizio.

La versione del servizio è facoltativa. Se specifichi la versione del servizio, Profiler può aggregare le informazioni di profilazione di più istanze e visualizzarle correttamente. Può essere usato per contrassegnare versioni diverse dei tuoi servizi durante il deployment. La UI di Profiler consente di filtrare i dati in base alla versione del servizio; in questo modo, è possibile confrontare le prestazioni delle versioni precedenti e più recenti del codice.

Il valore dell'argomento service-version è una stringa in formato libero, ma i valori per questo argomento in genere sono come numeri di versione, ad esempio 1.0.0 o 2.1.2.

Logging agente

L'agente di profilazione può segnalare le informazioni di logging. Per abilitare il logging, imposta l'opzione logLevel all'avvio dell'agente. I valori logLevel supportati sono:

  • 0: disabilita il logging di tutti gli agenti.
  • 1: abilita il logging degli errori.
  • 2: attiva il logging degli avvisi (impostazione predefinita).
  • 3: attiva il logging delle informazioni.
  • 4: attiva il logging di debug.

Imposta il valore logLevel nello stesso oggetto che fornisce il contesto del servizio:

require('@google-cloud/profiler').start({
    serviceContext: { ... }
    logLevel:       3
});

Esecuzione con Linux alpino

L'agente di profilazione Node.js per Linux Alps è supportato solo per le configurazioni di Google Kubernetes Engine.

Errore di build

Se esegui npm install e la build non riesce e restituisce il seguente errore, nel Dockerfile mancano alcune dipendenze della build:

ERR! stack Error: not found: make

Per risolvere il problema, aggiungi la seguente istruzione alla fase di creazione del tuo Dockerfile:

RUN apk add python3 g++ make

Errore di autenticazione

Se utilizzi immagini Docker eseguite con Linux Alps (ad esempio golang:alpine o solo alpine), potresti visualizzare il seguente errore di autenticazione:

connection error: desc = "transport: authentication handshake failed: x509: failed to load system roots and no roots provided"

Tieni presente che, per visualizzare l'errore, devi avere abilitato il logging dell'agente.

L'errore indica che nelle immagini Docker con Linux Alps non sono installati i certificati SSL root per impostazione predefinita. Questi certificati sono necessari affinché l'agente di profilazione possa comunicare con l'API Profiler. Per risolvere questo errore, aggiungi il seguente comando apk al Dockerfile:

FROM alpine
...
RUN apk add --no-cache ca-certificates

Devi quindi ricreare la build ed eseguire nuovamente il deployment dell'applicazione.

Problemi noti

L'agente di profilazione per Node.js interferisce con la normale uscita dal programma; la chiusura del programma può richiedere fino a un'ora dopo il completamento di tutte le attività del programma. Quando emetti un SIGINT, ad esempio utilizzando Ctrl-C, il processo viene interrotto normalmente.

Passaggi successivi