Configurazione di Cloud Logging per Node.js

Per le applicazioni Node.js, i plug-in vengono gestiti per le librerie di logging Winston e Bunyan più diffuse. Winston è una libreria per uso generico che implementa vari formatter di log e trasporti. Bunyan, specializzato per i log JSON strutturati, supporta la formattazione dei log facendo passare i dati alla riga di comando Bunyan.

Puoi anche utilizzare la libreria client di Logging per Node.js direttamente o creare le tue integrazioni con la tua libreria di logging preferita. Puoi utilizzare ad esempio il framework di log Pino.

Per utilizzare Winston o Bunyan su un'istanza di macchina virtuale (VM) Compute Engine, non è necessario installare l'agente Logging.

Prima di iniziare

1. Accedi al tuo account Google Cloud. Se non conosci Google Cloud, crea un account per valutare le prestazioni dei nostri prodotti in scenari reali. I nuovi clienti ricevono anche 300 $di crediti gratuiti per l'esecuzione, il test e il deployment dei carichi di lavoro.

2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

3. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

4. Attiva Cloud Logging API.

   Abilita l'API

5. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

   Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

   Go to project selector

6. Assicurati che la fatturazione sia attivata per il tuo progetto Google Cloud.

7. Attiva Cloud Logging API.

   Abilita l'API

8. Prepara l'ambiente per lo sviluppo Node.js.

   Vai alla guida alla configurazione di Node.js

Configurazione logging

Questa sezione descrive come installare e configurare i plug-in per le librerie di logging di Winston e Bunyan. Per Bunyan, vengono fornite informazioni su come utilizzare Bunyan con un'applicazione Node.js Express.

Puoi usare altre librerie o framework. Ad esempio, puoi utilizzare il framework di log Pino. Per il codice campione che utilizza OpenTelemetry per raccogliere metriche e dati di traccia e il framework di log Pino per raccogliere i dati di log, consulta Generare tracce e metriche con Node.js. Se utilizzi Pino, devi implementare una mappatura tra i livelli di gravità Pino e quelli utilizzati da Cloud Logging. Per esempio di codice, consulta Mappatura dei livelli di log di Pino.

Installazione e configurazione del plug-in Winston

Cloud Logging fornisce un plug-in per la libreria Node.js Logging di Winston. Il plug-in Logging per Winston offre un livello più semplice e di livello superiore per l'uso di Logging.

Per installare e configurare il plug-in Winston, procedi nel seguente modo:

1. Per installare il plug-in di Winston di Logging, utilizza npm:

   npm install --save @google-cloud/logging-winston winston

2. Importa il plug-in e aggiungilo alla configurazione di Winston:

   const winston = require('winston');
   
   // Imports the Google Cloud client library for Winston
   const {LoggingWinston} = require('@google-cloud/logging-winston');
   
   const loggingWinston = new LoggingWinston();
   
   // Create a Winston logger that streams to Cloud Logging
   // Logs will be written to: "projects/YOUR_PROJECT_ID/logs/winston_log"
   const logger = winston.createLogger({
     level: 'info',
     transports: [
       new winston.transports.Console(),
       // Add Cloud Logging
       loggingWinston,
     ],
   });
   
   // Writes some log entries
   logger.error('warp nacelles offline');
   logger.info('shields at 99%');

3. Configura il plug-in.

   Puoi personalizzare il comportamento del plug-in Winston utilizzando le stesse opzioni di configurazione supportate dalla libreria client Cloud dell'API Cloud Logging per Node.js. Queste opzioni possono essere trasmesse nell'oggetto options passato al costruttore del plug-in.

Installare e configurare il plug-in Bunyan

Cloud Logging fornisce un plug-in per la libreria Node.js Logging Bunyan. Il plug-in Logging per Bunyan fornisce un livello più semplice e di livello superiore per l'uso di Logging.

Per installare e configurare il plug-in Bunyan, procedi nel seguente modo:

1. Per installare il plug-inBunyan di Logging, utilizza npm:

   npm install --save bunyan @google-cloud/logging-bunyan

2. Importa il plug-in e aggiungilo alla tua configurazione Bunyan:

   const bunyan = require('bunyan');
   
   // Imports the Google Cloud client library for Bunyan
   const {LoggingBunyan} = require('@google-cloud/logging-bunyan');
   
   // Creates a Bunyan Cloud Logging client
   const loggingBunyan = new LoggingBunyan();
   
   // Create a Bunyan logger that streams to Cloud Logging
   // Logs will be written to: "projects/YOUR_PROJECT_ID/logs/bunyan_log"
   const logger = bunyan.createLogger({
     // The JSON payload of the log as it appears in Cloud Logging
     // will contain "name": "my-service"
     name: 'my-service',
     streams: [
       // Log to the console at 'info' and above
       {stream: process.stdout, level: 'info'},
       // And log to Cloud Logging, logging at 'info' and above
       loggingBunyan.stream('info'),
     ],
   });
   
   // Writes some log entries
   logger.error('warp nacelles offline');
   logger.info('shields at 99%');

3. Configura il plug-in.

   Puoi personalizzare il comportamento del plug-in Bunyan utilizzando le stesse opzioni di configurazione supportate dalla libreria client Cloud dell'API Cloud Logging per Node.js. Queste opzioni possono essere trasmesse nell'oggetto options passato al costruttore del plug-in.

Usa Bunyan ed Express

Puoi configurare e utilizzare Bunyan con Logging in un'applicazione Node.js Express.

// Imports the Google Cloud client library for Bunyan.
const lb = require('@google-cloud/logging-bunyan');

// Import express module and create an http server.
const express = require('express');

async function startServer() {
  const {logger, mw} = await lb.express.middleware({
    logName: 'samples_express',
  });
  const app = express();

  // Install the logging middleware. This ensures that a Bunyan-style `log`
  // function is available on the `request` object. This should be the very
  // first middleware you attach to your app.
  app.use(mw);

  // Setup an http route and a route handler.
  app.get('/', (req, res) => {
    // `req.log` can be used as a bunyan style log method. All logs generated
    // using `req.log` use the current request context. That is, all logs
    // corresponding to a specific request will be bundled in the Stackdriver
    // UI.
    req.log.info('this is an info log message');
    res.send('hello world');
  });

  const port = process.env.PORT || 8080;

  // `logger` can be used as a global logger, one not correlated to any specific
  // request.
  logger.info({port}, 'bonjour');

  // Start listening on the http server.
  const server = app.listen(port, () => {
    console.log(`http server listening on port ${port}`);
  });

  app.get('/shutdown', (req, res) => {
    res.sendStatus(200);
    server.close();
  });
}

startServer();

Per ulteriori informazioni sull'installazione, consulta la documentazione relativa alle librerie Cloud Logging per Node.js. Puoi anche segnalare problemi utilizzando lo strumento Issue Tracker.

Scrivi i log con la libreria client di Cloud Logging

Per informazioni sull'utilizzo diretto della libreria client di Cloud Logging per Node.js, consulta Librerie client di Cloud Logging.

Esegui su Google Cloud

Affinché un'applicazione possa scrivere log utilizzando le librerie Cloud Logging per Node.js, l'account di servizio per la risorsa sottostante deve avere il ruolo Logs Writer (roles/logging.logWriter) IAM. La maggior parte degli ambienti Google Cloud configura automaticamente l'account di servizio predefinito.

App Engine

Cloud Logging è abilitato automaticamente per App Engine e l'account di servizio predefinito della tua app ha le autorizzazioni IAM per scrivere le voci di log per impostazione predefinita.

Per scrivere voci di log dalla tua app, ti consigliamo di utilizzare Bunyan o Winston come descritto in questa pagina.

Per ulteriori informazioni, consulta Scrittura e visualizzazione dei log.

Google Kubernetes Engine (GKE)

GKE concede automaticamente all'account di servizio predefinito il ruolo IAM Writer log (roles/logging.logWriter). Se utilizzi Workload Identity con questo account di servizio predefinito per consentire ai carichi di lavoro di accedere a specifiche API Google Cloud, non sono necessarie ulteriori configurazioni. Tuttavia, se utilizzi Workload Identity con un account di servizio IAM personalizzato, assicurati che l'account di servizio personalizzato abbia il ruolo di Writer log (roles/logging.logWriter).

Se necessario, puoi anche utilizzare il comando seguente per aggiungere l'ambito di accesso logging.write durante la creazione del cluster:

gcloud container clusters create example-cluster-name \
    --scopes https://www.googleapis.com/auth/logging.write

Compute Engine

Nota: per utilizzare le librerie Cloud Logging per Node.js su un'istanza VM di Compute Engine, non è necessario installare l'agente Cloud Logging.

Quando utilizzi istanze VM di Compute Engine, aggiungi l'ambito di accesso cloud-platform a ogni istanza. Quando crei una nuova istanza mediante la console Google Cloud, puoi eseguire questa operazione nella sezione Identità e accesso API del riquadro Crea istanza. Utilizza l'account di servizio predefinito di Compute Engine o un altro account di servizio di tua scelta e seleziona Consenti l'accesso completo a tutte le API Cloud nella sezione Identità e accesso API. Indipendentemente dall'account di servizio selezionato, assicurati che gli sia stato concesso il ruolo Writer log nella sezione IAM e amministrazione della console Google Cloud.

Cloud Functions

Cloud Functions concede il ruolo Writer log per impostazione predefinita.

Le librerie Cloud Logging per Node.js possono essere utilizzate senza dover fornire esplicitamente le credenziali.

Cloud Functions è configurato per utilizzare Cloud Logging automaticamente.

Nota: i log scritti su stdout e stderr vengono inviati automaticamente a Cloud Logging per te, senza dover utilizzare le librerie Cloud Logging per Node.js.

Esegui localmente e altrove

Per utilizzare le librerie Cloud Logging per Node.js al di fuori di Google Cloud, inclusa l'esecuzione della libreria sulla tua workstation, sui computer del tuo data center o sulle istanze VM di un altro provider cloud, devi fornire l'ID progetto Google Cloud e le credenziali dell'account di servizio appropriate direttamente alle librerie Cloud Logging per Node.js.

Per gli account di servizio esistenti:

1. Concedi all'account di servizio il ruolo IAM Writer log (roles/logging.logWriter). Per ulteriori informazioni sui ruoli IAM, consulta Controllo dell'accesso.

2. Configura Credenziali predefinite dell'applicazione.

Se non hai un account di servizio, creane uno. Per informazioni su questa procedura, vedi Creare account di servizio.

Per informazioni generali sui metodi che puoi utilizzare per l'autenticazione, consulta Terminologia: account di servizio.

Utilizza Winston:

// Imports the Google Cloud client library for Winston
const {LoggingWinston} = require('@google-cloud/logging-winston');

// Creates a client
const loggingWinston = new LoggingWinston({
  projectId: 'your-project-id',
  keyFilename: '/path/to/key.json',
});

Usa Bunyan:

// Imports the Google Cloud client library for Bunyan
const {LoggingBunyan} = require('@google-cloud/logging-bunyan');

// Creates a client
const loggingBunyan = new LoggingBunyan({
  projectId: 'your-project-id',
  keyFilename: '/path/to/key.json',
});

Visualizza i log

Nella console Google Cloud, vai alla pagina Esplora log:

Vai a Esplora log

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

In Esplora log, devi specificare una o più risorse, ma la selezione delle risorse potrebbe non essere chiara. Ecco alcuni suggerimenti per iniziare:

• Se esegui il deployment della tua applicazione in App Engine o utilizzi librerie specifiche di App Engine, imposta la risorsa su Applicazione GAE.

• Se esegui il deployment della tua applicazione su Compute Engine, imposta la risorsa su Istanza VM GCE.

• Se esegui il deployment della tua applicazione su Google Kubernetes Engine, la configurazione del logging del cluster determina il tipo di risorsa delle voci di log. Per una discussione dettagliata sulle soluzioni legacy di Google Cloud Observability e sulle soluzioni Kubernetes Monitoring di Google Cloud Observability e su come queste opzioni influiscono sul tipo di risorsa, consulta Migrazione a Kubernetes Monitoring di Google Cloud Observability.

• Se la tua applicazione utilizza direttamente l'API Cloud Logging, la risorsa dipende dall'API e dalla configurazione. Ad esempio, nella tua applicazione puoi specificare una risorsa o utilizzarne una predefinita.

• Se non vedi alcun log in Esplora log, per vedere tutte le voci di log passa alla modalità di query avanzata e utilizza una query vuota.

  1. Per passare alla modalità di query avanzata, fai clic su menu (▾) nella parte superiore di Esplora log e seleziona Converti in filtro avanzato.
  2. Cancella i contenuti visualizzati nella casella dei filtri.
  3. Fai clic su Invia filtro.

  Puoi esaminare le singole voci per identificare le risorse.

Per ulteriori informazioni, consulta Utilizzo di Esplora log.