Instrumentez les applications Node.js pour Error Reporting

Vous pouvez envoyer des rapports d'erreurs à Error Reporting depuis des applications Node.js à l'aide de la bibliothèque Error Reporting pour Node.js. Utilisez la bibliothèque Error Reporting pour Node.js pour créer des groupes d'erreurs dans les cas suivants :

• Un bucket de journaux contenant vos entrées de journaux est soumis à un chiffrement géré par le client clés (CMEK).
• Le bucket de journaux remplit l'une des conditions suivantes :
  • Le bucket de journaux est stocké dans le projet où les entrées de journal d'origine.
  • Les entrées de journal ont été acheminées vers un projet, puis ce projet les a stockées dans un bucket de journaux dont il est propriétaire.
• Vous souhaitez signaler des événements d'erreur personnalisés.

Error Reporting est intégré à certains services Google Cloud, tels que Cloud Functions, App Engine, Compute Engine et Google Kubernetes Engine. Error Reporting vous permet d'afficher les erreurs qui sont consignées dans Cloud Logging par les applications exécutées sur ces services. Pour en savoir plus, consultez Exécution sur Google Cloud sur ce .

Vous pouvez également envoyer des données d'erreur à Error Reporting à l'aide de Logging. Pour en savoir plus sur les exigences en matière de mise en forme des données, consultez la page Formater les messages d'erreur dans Logging.

Avant de commencer

1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

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. Make sure that billing is enabled for your Google Cloud project.

4. Enable the Error Reporting API .

   Enable the 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. Make sure that billing is enabled for your Google Cloud project.

7. Enable the Error Reporting API .

   Enable the API

8. Préparez votre environnement au développement de Node.js.

   Accéder au guide de configuration de Node.js

Installer la bibliothèque cliente

La bibliothèque Error Reporting pour Node.js vous permet de surveiller et d'afficher les erreurs signalées par Applications Node.js exécutées depuis presque n'importe quel environnement

1. Installez le package à l'aide de npm :

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

2. Importez la bibliothèque et créez un client pour commencer à signaler les erreurs :

   // 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!');

Pour en savoir plus sur l'installation, consultez la documentation sur la bibliothèque Error Reporting pour Node.js. Vous pouvez également signaler d'éventuels problèmes à l'aide de l'outil de suivi des problèmes.

Configurer la bibliothèque cliente

Vous pouvez personnaliser le comportement de la bibliothèque Error Reporting pour Node.js. Consultez la configuration de la bibliothèque pour afficher la liste des options de configuration possibles. Ces options peuvent être transmises dans l'objet options, qui est lui-même transmis au constructeur de la bibliothèque.

Autres intégrations

Pour en savoir plus sur les intégrations entre la bibliothèque Error Reporting pour Node.js et les autres frameworks Web Node.js, consultez le dépôt de la bibliothèque sur GitHub.

Exécuter des applications sur Google Cloud

Pour créer des groupes d'erreurs à l'aide de projects.events.report, votre compte de service doit disposer du rôle Rédacteur Error Reporting (roles/errorreporting.writer).

Certains services Google Cloud accordent automatiquement Rédacteur Error Reporting (roles/errorreporting.writer) au niveau approprié de service géré. Toutefois, vous devez attribuer ce rôle au compte de service approprié pour certains services.

Environnement flexible App Engine

App Engine accorde le rôle Rôle de rédacteur pour Error Reporting (roles/errorreporting.writer) automatiquement à votre compte de service par défaut.

La bibliothèque Error Reporting pour Node.js peut être utilisée sans avoir à fournir explicitement des identifiants.

Error Reporting est automatiquement activé pour les applications de l'environnement flexible App Engine. Aucune configuration supplémentaire n'est requise.

Remarque :Les entrées de journal d'erreurs écrites dans stderr sont traitées automatiquement par Error Reporting, sans avoir à utiliser Bibliothèque Error Reporting pour Node.js directement.

Google Kubernetes Engine

Pour utiliser Error Reporting avec Google Kubernetes Engine, effectuer les opérations suivantes:

1. Assurez-vous que le compte de service à utiliser par votre conteneur a été attribué au rôle Rédacteur Error Reporting (roles/errorreporting.writer).

   Vous pouvez utiliser le compte de service Compute Engine par défaut ou un compte de service personnalisé.

   Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations.

2. Créez votre cluster et attribuez-lui le rôle cloud-platform niveau d'accès.

   Par exemple, la commande de création suivante spécifie la portée d'accès cloud-platform et un compte de service :

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

Remarque : Une fois le cluster créé, vous ne pouvez plus modifier son compte de service.

Compute Engine

Pour utiliser Error Reporting avec des instances de VM Compute Engine, effectuer les opérations suivantes:

1. Assurez-vous que le compte de service à utiliser par votre instance de VM a reçu le rôle Rédacteur Error Reporting (roles/errorreporting.writer).

   Vous pouvez utiliser le compte de service Compute Engine par défaut ou un compte de service personnalisé.

   Pour en savoir plus sur l'attribution de rôles, consultez la page Gérer l'accès aux projets, aux dossiers et aux organisations

2. Dans la console Google Cloud, accédez à la page Instances de VM :

   Accéder à la page Instances de VM

   Si vous utilisez la barre de recherche pour trouver cette page, sélectionnez le résultat dont le sous-titre est Compute Engine.

3. Sélectionnez l'instance de VM à laquelle vous souhaitez attribuer le niveau d'accès cloud-platform.

4. Cliquez sur Arrêter, puis sur Modifier.

5. Dans la section Identité et accès à l'API, sélectionnez un compte de service doté du rôle Rédacteur Error Reporting (roles/errorreporting.writer).

6. Dans la section Niveaux d'accès, sélectionnez Autoriser l'accès complet à l'ensemble des API Cloud, puis enregistrez vos modifications.

7. Cliquez sur Démarrer/Réactiver.

Cloud Functions

Les fonctions Cloud Run accorde les autorisations Rôle de rédacteur pour Error Reporting (roles/errorreporting.writer) automatiquement à votre compte de service par défaut.

La bibliothèque Error Reporting pour Node.js peut être utilisée sans avoir à fournir explicitement des identifiants.

Les fonctions Cloud Run sont configurées pour utiliser Error Reporting automatiquement. Les exceptions JavaScript non gérées apparaîtront dans Logging et seront traitées par Error Reporting sans avoir à utiliser la bibliothèque Error Reporting pour Node.js.

Remarque : Les entrées de journal sont traitées automatiquement si elles contiennent une trace de pile, et ne spécifient aucune gravité de journal ou une gravité de journal d'au moins ERROR, sans qu'il soit nécessaire d'utiliser la bibliothèque Error Reporting pour Node.js.

Exemple:

// 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!');

Exemple

Vous pouvez signaler une erreur manuellement en appelant la méthode report, comme illustré dans l'exemple suivant :

// 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!');
});

Signaler des erreurs avec Express.js

La bibliothèque Error Reporting pour Node.js est capable d'intégrer Error Reporting dans les frameworks Web Node.js populaires tels que Express.js :

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.');
});

Exécuter des applications dans un environnement de développement local

Pour utiliser la bibliothèque Error Reporting pour Node.js dans un environnement de développement local, procédez comme suit : par exemple en exécutant la bibliothèque sur votre propre poste de travail, vous devez fournir votre bibliothèque Error Reporting pour Node.js avec les identifiants par défaut de l'application locale. Pour en savoir plus, consultez S'authentifier auprès d'Error Reporting.

Pour utiliser les exemples Node.js de cette page dans un environnement de développement local, installez et initialisez gcloud CLI, puis configurez le service Identifiants par défaut de l'application à l'aide de vos identifiants utilisateur.

1. Install the Google Cloud CLI.

2. To initialize the gcloud CLI, run the following command:

   gcloud init

3. If you're using a local shell, then create local authentication credentials for your user account:

   gcloud auth application-default login

   You don't need to do this if you're using Cloud Shell.

   Note: If the gcloud CLI prints a warning that your account doesn't have the serviceusage.services.use permission, then some gcloud CLI commands and client libraries might not work. Ask an administrator to grant you the Service Usage Consumer IAM role (roles/serviceusage.serviceUsageConsumer), then run the following command:

   gcloud auth application-default set-quota-project PROJECT_ID

Pour en savoir plus, consultez Set up authentication for a local development environment.

La méthode projects.events.report est également compatible avec les clés API. Si vous souhaitez utiliser des clés API pour l'authentification, vous n'avez pas besoin de configurer un fichier d'identifiants par défaut de l'application local. Pour en savoir plus, consultez Créer une clé API dans la documentation sur l'authentification Google Cloud

Exemple:

// 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!');

Afficher les rapports d'erreurs

Dans la console Google Cloud, accédez à la page Error Reporting:

Accéder à Error Reporting

Vous pouvez également accéder à cette page à l'aide de la barre de recherche.

Pour en savoir plus, consultez la page Afficher les erreurs.