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 afin de créer des groupes d'erreurs dans les cas suivants:
- Votre bucket de journaux comporte des clés de chiffrement gérées par le client(CMEK).
- Vos buckets de journaux ne se trouvent pas dans la région
global
. - 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
- Connectez-vous à votre compte Google Cloud. Si vous débutez sur Google Cloud, créez un compte pour évaluer les performances de nos produits en conditions réelles. Les nouveaux clients bénéficient également de 300 $ de crédits gratuits pour exécuter, tester et déployer des charges de travail.
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Vérifiez que la facturation est activée pour votre projet Google Cloud.
-
Activez Error Reporting API .
-
In the Google Cloud console, on the project selector page, select or create a Google Cloud project.
-
Vérifiez que la facturation est activée pour votre projet Google Cloud.
-
Activez Error Reporting API .
- Préparez votre environnement au développement 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
-
Installez le package à l'aide de npm :
npm install --save @google-cloud/error-reporting
-
Importez la bibliothèque et créez un client pour commencer à signaler les erreurs :
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 en utilisant
projects.events.report
, votre compte de service requiert
Rôle de rédacteur pour 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 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.Google Kubernetes Engine
Pour utiliser Error Reporting avec Google Kubernetes Engine, effectuer les opérations suivantes:
Assurez-vous que le compte de service que votre conteneur doit utiliser a été accordé le Rôle de rédacteur pour 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
Créez votre cluster et accordez-lui le rôle
cloud-platform
niveau d'accès.Par exemple, la commande "create" suivante spécifie le champ :
cloud-platform
niveau d'accès et un compte de service:gcloud container clusters create CLUSTER_NAME --service-account SERVICE_ACCT_NAME --scopes=cloud-platform
Compute Engine
Pour utiliser Error Reporting avec des instances de VM Compute Engine, effectuer les opérations suivantes:
Assurez-vous que le compte de service que doit utiliser votre instance de VM a été accordé le Rôle de rédacteur pour 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
-
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.
Sélectionnez l'instance de VM sur laquelle vous souhaitez recevoir le
cloud-platform
niveau d'accès.Cliquez sur Arrêter, puis sur Modifier.
Dans la section Identité et accès à l'API, sélectionnez un compte de service dispose du rôle "Rédacteur Error Reporting" (
roles/errorreporting.writer
).Dans la section Niveaux d'accès, Sélectionnez Allow full access to all Cloud APIs (Autoriser l'accès complet à l'ensemble des API Cloud), puis enregistrez vos modifications.
Cliquez sur Démarrer/Réactiver.
Cloud Functions
Cloud Functions 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.
Cloud Functions est configuré de manière à 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.
Exemple:Exemple
Vous pouvez signaler une erreur manuellement en appelant la méthode report
, comme illustré dans l'exemple suivant :
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 :
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.
- Installez Google Cloud CLI.
-
Pour initialiser gcloudCLI, exécutez la commande suivante :
gcloud init
-
Créez des identifiants d'authentification locaux pour votre compte Google :
gcloud auth application-default login
Pour en savoir plus, consultez les sections sur Configurer l'authentification pour un environnement de développement local.
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 la page Créer une clé API dans la documentation sur l'authentification Google Cloud
Afficher les rapports d'erreurs
Dans la console Google Cloud, accédez à la page 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.