Strumenti delle app Node.js per Error Reporting

Puoi inviare report sugli errori a Error Reporting dalle applicazioni Node.js utilizzando la libreria Error Reporting per Node.js. Utilizza la libreria Error Reporting per Node.js per creare gruppi di errori nei seguenti casi:

• Il bucket di log ha chiavi di crittografia gestite dal cliente (CMEK).
• I bucket di log non si trovano nella regione global.
• Vuoi segnalare eventi di errore personalizzati.

Error Reporting è integrato con alcuni servizi Google Cloud, come Cloud Functions e App Engine, Compute Engine e Google Kubernetes Engine. Error Reporting visualizza gli errori registrati in Cloud Logging dalle applicazioni in esecuzione su questi servizi. Per ulteriori informazioni, vai ad In esecuzione su Google Cloud in questa pagina.

Puoi anche inviare i dati sugli errori a Error Reporting utilizzando Logging. Per informazioni sui requisiti di formattazione dei dati, consulta Formattazione dei messaggi di errore in 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. Nella pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.

   Nota: se non prevedi di conservare le risorse create in questa procedura, crea un progetto anziché selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto, rimuovendo tutte le risorse associate.

   Vai al selettore progetti

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

4. Attiva Error Reporting API .

   Abilita l'API

5. Nella pagina del selettore di progetti della console Google Cloud, seleziona o crea un progetto Google Cloud.

   Nota: se non prevedi di conservare le risorse create in questa procedura, crea un progetto anziché selezionarne uno esistente. Dopo aver completato questi passaggi, puoi eliminare il progetto, rimuovendo tutte le risorse associate.

   Vai al selettore progetti

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

7. Attiva Error Reporting API .

   Abilita l'API

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

   Vai alla guida alla configurazione di Node.js

Installa la libreria client

La libreria di Error Reporting per Node.js consente di monitorare e visualizzare gli errori segnalati dalle applicazioni Node.js in esecuzione praticamente ovunque.

1. Usa npm per installare il pacchetto:

   npm install --save @google-cloud/error-reporting

2. Importa la libreria e crea un'istanza di client per iniziare a segnalare gli errori:

   Visualizza su GitHub Feedback

   // Imports the Google Cloud client library
   const {ErrorReporting} = require('@google-cloud/error-reporting');
   
   // Instantiates a client
   const errors = new ErrorReporting();
   
   // Reports a simple error
   errors.report('Something broke!');

Per ulteriori informazioni sull'installazione, consulta la documentazione relativa alla libreria di Error Reporting per Node.js. Puoi anche segnalare i problemi utilizzando lo strumento Issue Tracker.

Configura la libreria client

Puoi personalizzare il comportamento della libreria di Error Reporting per Node.js. Consulta la configurazione della libreria per un elenco di possibili opzioni di configurazione. Queste opzioni possono essere passate nell'oggetto options passato al costruttore della libreria.

Altre integrazioni

Per ulteriori informazioni sulle integrazioni tra la libreria Error Reporting per Node.js e altri framework web Node.js, consulta il repository della libreria su GitHub.

Esegui app su Google Cloud

Per creare gruppi di errori utilizzando projects.events.report, il tuo account di servizio richiede il ruolo Writer Error Reporting (roles/errorreporting.writer).

Alcuni servizi Google Cloud concedono automaticamente il ruolo Writer Error Reporting (roles/errorreporting.writer) all'account di servizio appropriato. Tuttavia, devi concedere questo ruolo all'account di servizio appropriato per alcuni servizi.

Ambiente flessibile di App Engine

App Engine concede automaticamente il ruolo Writer Error Reporting (roles/errorreporting.writer) al tuo account di servizio predefinito.

La libreria Error Reporting per Node.js può essere utilizzata senza dover fornire esplicitamente le credenziali.

Error Reporting è abilitato automaticamente per le applicazioni nell'ambiente flessibile di App Engine. Non è richiesta alcuna ulteriore configurazione.

Nota: i log degli errori scritti in stderr vengono elaborati automaticamente da Error Reporting, senza bisogno di utilizzare direttamente la libreria di Error Reporting per Node.js.

Google Kubernetes Engine

Per utilizzare Error Reporting con Google Kubernetes Engine:

1. Assicurati che all'account di servizio che deve essere utilizzato dal container sia stato concesso il ruolo Writer Error Reporting (roles/errorreporting.writer).

   Puoi utilizzare l'account di servizio predefinito di Compute Engine o un account di servizio personalizzato.

   Per informazioni sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.

2. Crea il cluster e concedi al cluster l'ambito di accesso cloud-platform.

   Ad esempio, il seguente comando create specifica l'ambito di accesso cloud-platform e un account di servizio:

   gcloud container clusters create CLUSTER_NAME --service-account  SERVICE_ACCT_NAME --scopes=cloud-platform
   

Nota: dopo aver creato un cluster, non puoi modificare il relativo account di servizio.

Compute Engine

Per utilizzare Error Reporting con le istanze VM di Compute Engine:

1. Assicurati che all'account di servizio che deve essere utilizzato dall'istanza VM sia stato concesso il ruolo Writer Error Reporting (roles/errorreporting.writer).

   Puoi utilizzare l'account di servizio predefinito di Compute Engine o un account di servizio personalizzato.

   Per informazioni sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.

2. Nella console Google Cloud, seleziona Compute Engine e poi Istanze VM, oppure fai clic sul pulsante seguente:

   Vai a Istanze VM

3. Seleziona l'istanza VM che vuoi ricevere l'ambito di accesso cloud-platform.

4. Fai clic su Interrompi e poi su Modifica.

5. Nella sezione Identità e accesso API, seleziona un account di servizio con il ruolo Writer Error Reporting (roles/errorreporting.writer).

6. Nella sezione Ambiti di accesso, seleziona Consenti l'accesso completo a tutte le API Cloud, quindi salva le modifiche.

7. Fai clic su Avvia/Riprendi.

Cloud Functions

Cloud Functions concede automaticamente il ruolo Writer Error Reporting (roles/errorreporting.writer) al tuo account di servizio predefinito.

La libreria Error Reporting per Node.js può essere utilizzata senza dover fornire esplicitamente le credenziali.

Cloud Functions è configurato per utilizzare automaticamente Error Reporting. Le eccezioni JavaScript non gestite verranno visualizzate in Logging e verranno elaborate da Error Reporting senza dover utilizzare la libreria di Error Reporting per Node.js.

Nota: le voci di log vengono elaborate automaticamente se contengono un'analisi dello stack e non specificano una gravità di log o una gravità di almeno ERROR, senza dover utilizzare la libreria di Error Reporting per Node.js.

Esempio:

Visualizza su GitHub Feedback

// Imports the Google Cloud client library
const {ErrorReporting} = require('@google-cloud/error-reporting');

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

// Reports a simple error
errors.report('Something broke!');

Esempio

Puoi segnalare manualmente un errore chiamando il metodo report, come mostrato nell'esempio seguente:

Visualizza su GitHub Feedback

// Imports the Google Cloud client library
const {ErrorReporting} = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = new ErrorReporting();

// Use the error message builder to customize all fields ...
const errorEvent = errors.event();

// Add error information
errorEvent.setMessage('My error message');
errorEvent.setUser('root@nexus');

// Report the error event
errors.report(errorEvent, () => {
  console.log('Done reporting error event!');
});

// Report an Error object
errors.report(new Error('My error message'), () => {
  console.log('Done reporting Error object!');
});

// Report an error by provided just a string
errors.report('My error message', () => {
  console.log('Done reporting error string!');
});

Segnalazione di errori con Express.js

La libreria Error Reporting per Node.js può integrare Error Reporting nei framework web Node.js popolari come Express.js:

Visualizza su GitHub Feedback

const express = require('express');

// Imports the Google Cloud client library
const {ErrorReporting} = require('@google-cloud/error-reporting');

// Instantiates a client
const errors = new ErrorReporting();

const app = express();

app.get('/error', (req, res, next) => {
  res.send('Something broke!');
  next(new Error('Custom error message'));
});

app.get('/exception', () => {
  JSON.parse('{"malformedJson": true');
});

// Note that express error handling middleware should be attached after all
// the other routes and use() calls. See the Express.js docs.
app.use(errors.express);

const PORT = process.env.PORT || 8080;
app.listen(PORT, () => {
  console.log(`App listening on port ${PORT}`);
  console.log('Press Ctrl+C to quit.');
});

Eseguire app in un ambiente di sviluppo locale

Per utilizzare la libreria Error Reporting per Node.js in un ambiente di sviluppo locale, ad esempio per eseguire la libreria sulla tua workstation, devi fornire la libreria Error Reporting per Node.js con le credenziali predefinite dell'applicazione locale. Per ulteriori informazioni, vedi Eseguire l'autenticazione in Error Reporting.

Per utilizzare gli esempi Node.js in questa pagina da un ambiente di sviluppo locale, installa e inizializza gcloud CLI, quindi configura Credenziali predefinite dell'applicazione con le tue credenziali utente.

1. Installa Google Cloud CLI.

2. Per initialize gcloud CLI, esegui questo comando:

   gcloud init

3. Crea credenziali di autenticazione locali per il tuo Account Google:

   gcloud auth application-default login

   Nota: se l&#gcloud CLI stampa un avviso che il tuo account non dispone dell'autorizzazione serviceusage.services.use, alcuni comandi dell'interfaccia a riga di comando gcloud CLI e le librerie client potrebbero non funzionare. Chiedi a un amministratore di concederti il ruolo IAM consumer di utilizzo dei servizi (roles/serviceusage.serviceUsageConsumer), quindi esegui il comando seguente:

   gcloud auth application-default set-quota-project PROJECT_ID

Per ulteriori informazioni, consulta Configura l'autenticazione per un ambiente di sviluppo locale.

Il metodo projects.events.report supporta anche le chiavi API. Se vuoi utilizzare le chiavi API per l'autenticazione, non è necessario configurare un file locale Credenziali predefinite dell'applicazione. Per ulteriori informazioni, consulta Crea una chiave API nella documentazione sull'autenticazione di Google Cloud.

Esempio:

Visualizza su GitHub Feedback

// Imports the Google Cloud client library
const {ErrorReporting} = require('@google-cloud/error-reporting');

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

// Reports a simple error
errors.report('Something broke!');

Visualizzazione dei rapporti degli errori

Nella console Google Cloud, seleziona Error Reporting oppure fai clic sul pulsante seguente e seleziona un progetto:

Vai a Error Reporting

Per ulteriori informazioni, consulta la sezione Visualizzazione degli errori.