Esempio di strumentazione Node.js

Puoi instrumentare un'applicazione JavaScript Node.js per raccogliere dati di tracce e metriche con l'SDK OpenTelemetry e un raccoglitore OpenTelemetry e per scrivere log JSON strutturati e correlati nell'output standard. Per sperimentare questa strumentazione, puoi scaricare ed eseguire l'applicazione di esempio Fastify, che genera dati di log, metriche e tracce e li esporta nel tuo progettoGoogle Cloud .

Informazioni sull'approccio di strumentazione

Quando utilizzi un raccoglitore OpenTelemetry, strumenta la tua applicazione con l'SDK e l'esportatore in-process OTLP dell'SDK. Questa strumentazione è indipendente dal fornitore. Esegui anche il deployment di un raccoglitore OpenTelemetry che riceve la telemetria dall'esportatore in-process e poi la esporta nel tuo progetto Google Cloud . Per scoprire di più sui raccoglitori, consulta Raccoglitore OpenTelemetry creato da Google.

Ti consigliamo di utilizzare un raccoglitore OpenTelemetry per esportare i dati di telemetria se il tuo ambiente supporta l'utilizzo di un raccoglitore. Per alcuni ambienti, devi utilizzare un esportatore in-process che invia i dati direttamente al tuo progettoGoogle Cloud . Per scoprire di più sulla strumentazione in-process, consulta Esegui la migrazione dall'esportatore Trace all'endpoint OTLP.

Per saperne di più sulla strumentazione, consulta i seguenti documenti:

Informazioni sulla strumentazione manuale e zero-code

Per questo linguaggio, OpenTelemetry definisce la strumentazione zero-code come la pratica di raccogliere dati di telemetria da librerie e framework senza apportare modifiche al codice. Tuttavia, devi installare i moduli e impostare le variabili di ambiente.

Questo documento non descrive la strumentazione zero-code. Per informazioni su questo argomento, consulta Strumentazione zero-code JavaScript.

Per informazioni generali, consulta Strumentazione OpenTelemetry per Node.

Prima di iniziare

  1. Installa Google Cloud CLI.

  2. Configura gcloud CLI per utilizzare la tua identità federata.

    Per saperne di più, consulta Accedi a gcloud CLI con la tua identità federata.

  3. Per inizializzare gcloud CLI, esegui questo comando: 

    gcloud init

  4. Crea o seleziona un progetto Google Cloud .

    Ruoli richiesti per selezionare o creare un progetto

    • Seleziona un progetto: la selezione di un progetto non richiede un ruolo IAM specifico. Puoi selezionare qualsiasi progetto per cui ti è stato concesso un ruolo.
    • Crea un progetto: per creare un progetto, devi disporre del ruolo Autore progetto (roles/resourcemanager.projectCreator), che contiene l'autorizzazione resourcemanager.projects.create. Scopri come concedere i ruoli.

    • Crea un progetto Google Cloud :

      gcloud projects create PROJECT_ID

      Sostituisci PROJECT_ID con un nome per il progetto Google Cloud che stai creando.

    • Seleziona il progetto Google Cloud che hai creato:

      gcloud config set project PROJECT_ID

      Sostituisci PROJECT_ID con il nome del progetto Google Cloud .

  5. Verifica che la fatturazione sia attivata per il tuo progetto Google Cloud .

  6. Abilita le API Cloud Logging, Cloud Monitoring, Cloud Trace e Telemetry, se non sono già abilitate:

    Ruoli richiesti per abilitare le API

    Per abilitare le API, devi disporre dell'autorizzazione serviceusage.services.enable. Se hai creato il progetto, probabilmente hai già questa autorizzazione tramite il ruolo Proprietario (roles/owner). In caso contrario, puoi ottenere questa autorizzazione tramite il ruolo Amministratore Service Usage (roles/serviceusage.serviceUsageAdmin). Scopri come concedere i ruoli. 

    gcloud services enable logging.googleapis.com monitoring.googleapis.com cloudtrace.googleapis.com telemetry.googleapis.com

  7. Per ottenere le autorizzazioni necessarie per consentire all'applicazione di esempio di scrivere dati di log, metriche e tracce, chiedi all'amministratore di concederti i seguenti ruoli IAM:

    Queste autorizzazioni sono sufficienti se esegui l'esempio in Cloud Shell, su risorse Google Cloud o in un ambiente di sviluppo locale. Per scoprire come configurare un progetto di quota, consulta Imposta il progetto di quota.

    Per ottenere le autorizzazioni necessarie per visualizzare i dati di log, metriche e tracce, chiedi all'amministratore di concederti i seguenti ruoli IAM nel progetto:

    Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

    Potresti anche riuscire a ottenere le autorizzazioni richieste tramite i ruoli personalizzati o altri ruoli predefiniti.

Strumenta la tua app per raccogliere tracce, metriche e log

Per instrumentare l'app in modo da raccogliere dati di tracce e metriche e scrivere log JSON strutturati nell'output standard, segui questi passaggi:

  1. Configura OpenTelemetry
  2. Configura l'app per precaricare la configurazione di OpenTelemetry
  3. Configura il logging strutturato
  4. Scrivi log strutturati

Configura OpenTelemetry

La configurazione predefinita per l'SDK OpenTelemetry Node.js esporta le tracce utilizzando il protocollo OTLP. Inoltre, configura OpenTelemetry in modo che utilizzi il formato W3C Trace Context per la propagazione del contesto della traccia. Questa configurazione garantisce che gli span abbiano la relazione padre-figlio corretta all'interno di una traccia.

Il seguente esempio di codice illustra un modulo JavaScript per configurare OpenTelemetry.

Per visualizzare l'esempio completo, seleziona il logo di GitHub nella barra degli strumenti dell'esempio.


diag.setLogger(
  new DiagConsoleLogger(),
  opentelemetry.core.diagLogLevelFromString(
    opentelemetry.core.getStringFromEnv('OTEL_LOG_LEVEL'),
  ),
);

const sdk = new opentelemetry.NodeSDK({
  instrumentations: getNodeAutoInstrumentations({
    // Disable noisy instrumentations
    '@opentelemetry/instrumentation-fs': {enabled: false},
  }),
  resourceDetectors: getResourceDetectorsFromEnv(),
  metricReader: getMetricReader(),
});

try {
  sdk.start();
  diag.info('OpenTelemetry automatic instrumentation started successfully');
} catch (error) {
  diag.error(
    'Error initializing OpenTelemetry SDK. Your application is not instrumented and will not produce telemetry',
    error,
  );
}

// Gracefully shut down the SDK to flush telemetry when the program exits
process.on('SIGTERM', () => {
  sdk
    .shutdown()
    .then(() => diag.debug('OpenTelemetry SDK terminated'))
    .catch(error => diag.error('Error terminating OpenTelemetry SDK', error));
});

L'esempio di codice precedente configura OpenTelemetry per esportare le metriche utilizzando il protocollo OTLP e utilizza il pacchetto @opentelemetry/auto-instrumentations-node per configurare tutte le strumentazioni Node.js disponibili.

Per assicurarti che tutta la telemetria in attesa venga svuotata e che le connessioni vengano chiuse correttamente prima dell'arresto dell'applicazione, il gestore SIGTERM chiama shutdown.

Per ulteriori informazioni e opzioni di configurazione, consulta Configurazione della strumentazione senza codice.

Configura l'app per precaricare la configurazione di OpenTelemetry

Per configurare l'app in modo che scriva log strutturati e raccolga metriche e dati di traccia utilizzando OpenTelemetry, aggiorna la chiamata dell'app in modo da precaricare il modulo di strumentazione con il flag --require di Node.js. L'utilizzo del flag --require garantisce che OpenTelemetry venga inizializzato prima dell'avvio dell'app. Per saperne di più, consulta la guida introduttiva di OpenTelemetry Node.js.

Il seguente esempio di codice mostra un Dockerfile che passa il flag --require:

CMD node --require ./build/src/instrumentation.js build/src/index.js 2>&1 | tee /var/log/app.log

Configura il logging strutturato

Per includere le informazioni sulla traccia nei log in formato JSON scritti nell'output standard, configura l'app in modo che generi log strutturati in formato JSON.

Il seguente esempio di codice illustra un oggetto Pino LoggerOptions che configura l'app per l'output di log strutturati JSON:


// Expected attributes that OpenTelemetry adds to correlate logs with spans
interface LogRecord {
  trace_id?: string;
  span_id?: string;
  trace_flags?: string;
  [key: string]: unknown;
}

// https://cloud.google.com/logging/docs/reference/v2/rest/v2/LogEntry#logseverity
const PinoLevelToSeverityLookup: Record<string, string | undefined> = {
  trace: 'DEBUG',
  debug: 'DEBUG',
  info: 'INFO',
  warn: 'WARNING',
  error: 'ERROR',
  fatal: 'CRITICAL',
};

export const loggerConfig = {
  messageKey: 'message',
  // Same as pino.stdTimeFunctions.isoTime but uses "timestamp" key instead of "time"
  timestamp(): string {
    return `,"timestamp":"${new Date(Date.now()).toISOString()}"`;
  },
  formatters: {
    log(object: LogRecord): Record<string, unknown> {
      // Add trace context attributes following Cloud Logging structured log format described
      // in https://cloud.google.com/logging/docs/structured-logging#special-payload-fields
      const {trace_id, span_id, trace_flags, ...rest} = object;

      return {
        'logging.googleapis.com/trace': trace_id,
        'logging.googleapis.com/spanId': span_id,
        'logging.googleapis.com/trace_sampled': trace_flags
          ? trace_flags === '01'
          : undefined,
        ...rest,
      };
    },
    // See
    // https://getpino.io/#/docs/help?id=mapping-pino-log-levels-to-google-cloud-logging-stackdriver-severity-levels
    level(label: string) {
      return {
        severity:
          PinoLevelToSeverityLookup[label] ?? PinoLevelToSeverityLookup['info'],
      };
    },
  },
} satisfies LoggerOptions;

La configurazione precedente estrae le informazioni sull'intervallo attivo dal messaggio di log e le aggiunge come attributi al log strutturato JSON. Questi attributi possono quindi essere utilizzati per correlare un log a una traccia:

  • logging.googleapis.com/trace: il nome della risorsa della traccia associata alla voce di log.
  • logging.googleapis.com/spanId: l'ID span nella traccia associata alla voce di log.
  • logging.googleapis.com/trace_sampled: Il valore di questo campo deve essere true o false.

Per saperne di più su questi campi, consulta la struttura LogEntry.

Per utilizzare la configurazione Pino con Fastify, passa l'oggetto di configurazione del logger durante la creazione dell'app Fastify:

// Create the Fastify app providing the Pino logger config
const fastify = Fastify({
  logger: loggerConfig,
});

Scrittura di log strutturati

Per scrivere log strutturati che rimandano a una traccia, utilizza il logger Pino fornito da Fastify. Ad esempio, la seguente istruzione mostra come chiamare il metodo Logger.info():

request.log.info({subRequests}, 'handle /multi request');

OpenTelemetry compila automaticamente le voci di log di Pino con il contesto dello span attualmente attivo nel contesto OpenTelemetry. Questo contesto di intervallo viene quindi incluso nei log JSON come descritto in Configura il logging strutturato.

Esegui un'app di esempio configurata per raccogliere i dati di telemetria

La strumentazione nell'app di esempio utilizza formati indipendenti dal fornitore, come JSON per i dati di log e OTLP per i dati di metriche e tracce. L'app utilizza anche il framework Fastify. OpenTelemetry Collector invia i dati di log e metriche al tuo progetto utilizzando gli esportatori di Google. Invia i dati di traccia al tuo progetto utilizzando l'API Telemetry, che utilizza OTLP.

L'app ha due endpoint:

  • L'endpoint /multi è gestito dalla funzione handleMulti. Il generatore di carico nell'app invia richieste all'endpoint /multi. Quando questo endpoint riceve una richiesta, invia da tre a sette richieste all'endpoint /single sul server locale.

    /**
 * handleMulti handles an http request by making 3-7 http requests to the /single endpoint.
 *
 * OpenTelemetry instrumentation requires no changes here. It will automatically generate a
 * span for the handler body.
 */
fastify.get('/multi', async request => {
  const subRequests = randInt(3, 8);
  request.log.info({subRequests}, 'handle /multi request');

  for (let i = 0; i < subRequests; i++) {
    await axios.get(`http://localhost:${port}/single`);
  }
  return 'ok';
});

  • L'endpoint /single è gestito dalla funzione handleSingle. Quando questo endpoint riceve una richiesta, rimane inattivo per un breve ritardo e poi risponde con una stringa.

    /**
 * handleSingle handles an http request by sleeping for 100-200 ms. It writes the number of
 * milliseconds slept as its response.
 */
fastify.get('/single', async request => {
  // Sleep between 100-200 milliseconds
  const sleepMillis = randInt(100, 200);
  request.log.info({sleepMillis}, 'Going to sleep');
  await sleep(sleepMillis);
  return `slept ${sleepMillis}\n`;
});

Scarica ed esegui il deployment dell'app

Per eseguire l'esempio:

  1. Nella console Google Cloud , attiva Cloud Shell.

    Attiva Cloud Shell

    Nella parte inferiore della console Google Cloud , viene avviata una sessione di Cloud Shell e viene visualizzato un prompt della riga di comando. Cloud Shell è un ambiente shell con Google Cloud CLI già installata e con valori già impostati per il progetto corrente. L'inizializzazione della sessione può richiedere alcuni secondi.

  2. Clona il repository:

    git clone https://github.com/GoogleCloudPlatform/opentelemetry-samples

  3. Vai alla directory di esempio:

    cd opentelemetry-samples/javascript/instrumentation-quickstart

  4. Crea ed esegui l'esempio:

    docker compose up --abort-on-container-exit

    Se non utilizzi Cloud Shell, esegui l'applicazione con la variabile di ambiente GOOGLE_APPLICATION_CREDENTIALS che punta a un file di credenziali. Credenziali predefinite dell'applicazione fornisce un file di credenziali in $HOME/.config/gcloud/application_default_credentials.json.

    # Set environment variables
export GOOGLE_CLOUD_PROJECT="PROJECT_ID"
export GOOGLE_APPLICATION_CREDENTIALS="$HOME/.config/gcloud/application_default_credentials.json"
export USERID="$(id -u)"

# Run
docker compose -f docker-compose.yaml -f docker-compose.creds.yaml up --abort-on-container-exit

Visualizza le metriche

La strumentazione OpenTelemetry nell'app di esempio genera metriche Prometheus che puoi visualizzare utilizzando Esplora metriche:

  • Prometheus/http_server_duration_milliseconds/histogram registra la durata delle richieste del server e memorizza i risultati in un istogramma.

  • Prometheus/http_client_duration_milliseconds/histogram registra la durata delle richieste client e memorizza i risultati in un istogramma.

Per visualizzare le metriche generate dall'app di esempio, segui questi passaggi:

  1. Nella console Google Cloud , vai alla pagina  Esplora metriche:

    Vai a Esplora metriche

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Monitoring.

  2. Nella barra degli strumenti della console Google Cloud , seleziona il tuo progetto Google Cloud . Per le configurazioni di App Hub, seleziona il progetto host di App Hub o il progetto di gestione della cartella app.
  3. Nell'elemento Metrica, espandi il menu Seleziona una metrica, digita http_server nella barra dei filtri e poi utilizza i sottomenu per selezionare un tipo di risorsa e una metrica specifici:
    1. Nel menu Risorse attive, seleziona Target Prometheus.
    2. Nel menu Categorie di metriche attive, seleziona Http.
    3. Nel menu Metriche attive, seleziona una metrica.
    4. Fai clic su Applica.

  4. Per aggiungere filtri che rimuovono le serie temporali dai risultati della query, utilizza l'elemento Filtro.

  5. Configura la modalità di visualizzazione dei dati.

    Quando le misurazioni di una metrica sono cumulative, Metrics Explorer normalizza automaticamente i dati misurati in base al periodo di allineamento, in modo che il grafico mostri una frequenza. Per saperne di più, consulta Kind, tipi e conversioni.

    Quando vengono misurati valori interi o doppi, ad esempio con le due metriche counter, Metrics Explorer somma automaticamente tutte le serie temporali. Per visualizzare i dati per le route HTTP /multi e /single, imposta il primo menu della voce Aggregazione su Nessuna.

    Per ulteriori informazioni sulla configurazione di un grafico, consulta Seleziona le metriche durante l'utilizzo di Esplora metriche.

Visualizza le tracce

Potrebbero essere necessari diversi minuti prima che i dati di traccia siano disponibili. Ad esempio, quando il tuo progetto riceve i dati di traccia, Google Cloud Observability potrebbe dover creare un database per archiviarli. La creazione del database può richiedere alcuni minuti e, durante questo periodo, non sono disponibili dati di traccia da visualizzare.

Per visualizzare i dati di traccia:

  1. Nella console Google Cloud , vai alla pagina Esplora tracce:

    Vai a Esplora tracce

    Puoi trovare questa pagina anche utilizzando la barra di ricerca.

  2. Nella sezione della tabella della pagina, seleziona una riga con il nome dello span /multi.

  3. Nel grafico di Gantt nel riquadro Dettagli su Trace, seleziona l'intervallo con etichetta /multi.

    Si apre un riquadro che mostra le informazioni sulla richiesta HTTP. Questi dettagli includono il metodo, il codice di stato, il numero di byte e lo user agent del chiamante.

  4. Per visualizzare i log associati a questa traccia, seleziona la scheda Log ed eventi.

    La scheda mostra i singoli log. Per visualizzare i dettagli della voce di log, espandila. Puoi anche fare clic su Visualizza log e visualizzare il log utilizzando Esplora log.

Per saperne di più sull'utilizzo della pagina Esplora tracce, consulta Trova ed esplora le tracce.

Visualizza i log

Da Esplora log puoi ispezionare i log e visualizzare le tracce associate, se presenti.

  1. Nella console Google Cloud , vai alla pagina Esplora log:

    Vai a Esplora log

    Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Logging.

  2. Individua un log con la descrizione di handle /multi request.

    Per visualizzare i dettagli del log, espandi la voce di log.

  3. Fai clic su Tracce in una voce di log con il messaggio "handle /multi request", quindi seleziona Visualizza dettagli traccia.

    Si apre un riquadro Dettagli su Trace che mostra la traccia selezionata.

    I dati di log potrebbero essere disponibili diversi minuti prima dei dati di traccia. Se si verifica un errore durante la visualizzazione dei dati di traccia, cercando una traccia per ID o seguendo i passaggi descritti in questa attività, attendi un minuto o due e riprova.

Per ulteriori informazioni sull'utilizzo di Esplora log, vedi Visualizza i log utilizzando Esplora log.

Passaggi successivi