L'API Error Reporting fournit les éléments suivants :
- Un simple point de terminaison pour signaler les erreurs de votre service en cours d'exécution.
- Accès en lecture aux groupes d'erreurs et aux erreurs associées.
Premiers pas
Activez l'API Error Reporting.
Rôles requis pour activer les API
Pour activer les API, vous avez besoin du rôle IAM Administrateur Service Usage (roles/serviceusage.serviceUsageAdmin), qui contient l'autorisation serviceusage.services.enable. Découvrez comment attribuer des rôles.
Autoriser l'utilisation de l'API
L'accès à l'API Error Reporting est contrôlé par les rôles et autorisations Identity and Access Management. Pour en savoir plus sur l'authentification et l'autorisation pour les API Google Cloud , consultez le guide d'authentification.
Modèle de données
L'API Error Reporting définit trois entités : les événements d'erreur, les groupes d'erreurs et les statistiques des groupes d'erreurs. L'objet error group stats est celui avec lequel la plupart des utilisateurs interagiront le plus souvent.
Événements d'erreur
Un ErrorEvent représente une occurrence unique d'une erreur dans votre application. L'objet contient des informations sur l'erreur, comme l'heure à laquelle elle s'est produite, le contexte dans lequel elle s'est produite et le message d'erreur renvoyé. Un événement d'erreur est garanti d'être disponible pendant au moins 30 jours après sa génération.
Groupes d'erreurs
Les objets ErrorGroup sont des collections d'événements d'erreur regroupés de manière logique. Le regroupement est basé sur les informations de la trace de pile de l'événement d'erreur. Un groupe d'erreurs est un objet simple qui ne contient que le nom, l'ID du groupe et les problèmes de suivi associés au groupe.
Pour mettre à jour les URL des problèmes de suivi, utilisez la méthode update de cette ressource.
Statistiques du groupe d'erreurs
Les objets ErrorGroupStats contiennent des informations détaillées sur un groupe d'erreurs. Ce sont les objets d'API avec lesquels vous interagirez le plus souvent. Les informations de l'objet groupStats incluent la première et la dernière fois qu'un événement d'erreur de ce groupe s'est produit, le nombre d'occurrences, le nombre d'utilisateurs concernés, etc. Cet objet est utile pour créer des widgets et des tableaux de bord personnalisés.
Opérations
L'API Error Reporting est compatible avec les opérations suivantes :
- Signaler un nouvel événement d'erreur
- Lister les statistiques des groupes d'erreurs
- Répertorier les événements associés à des erreurs
- Obtenir les groupes d'erreurs
- Mettre à jour les problèmes de suivi d'un groupe d'erreurs
Signaler les événements d'erreur
Vous pouvez signaler les événements associés à des erreurs à vos services en cours d'exécution en les écrivant dans ReportedErrorEvent. Cela permet de générer des messages d'erreur correctement formatés dans Cloud Logging. Le nom du journal obtenu est au format projects/<PROJECT_ID>/clouderrorreporting.googleapis.com%2Freported_errors. Cette méthode peut entraîner des coûts d'ingestion Cloud Logging minimes. Pour contrôler ces coûts, consultez la page Exclusion de journaux.
Vous pouvez également signaler de nouveaux événements d'erreur à Error Reporting en assemblant des entités d'événements d'erreur à partir de votre service en cours d'exécution et en les envoyant à la méthode events.report.
Lister les statistiques des groupes d'erreurs
Pour obtenir la liste des statistiques des groupes d'erreurs, envoyez une requête à la méthode groupStats.list. Vous pouvez transmettre un ou plusieurs paramètres de requête pour filtrer les statistiques de groupe renvoyées.
Répertorier les événements associés à des erreurs
Pour obtenir la liste des événements d'erreur appartenant à un groupe d'erreurs spécifique, envoyez une requête à la méthode events.list. Vous pouvez transmettre une condition de filtre à ces requêtes pour ne récupérer que les événements d'erreur qui se sont produits entre une heure de début et une heure de fin spécifiques, ou ceux qui correspondent à des contextes de service spécifiques.
Obtenir les groupes d'erreurs
Pour récupérer une ressource de groupe d'erreurs spécifique, envoyez une requête à la méthode groups.get.
Mettre à jour les groupes d'erreurs
Pour mettre à jour les URL de suivi des problèmes associées à un groupe d'erreurs, envoyez une ressource ErrorGroup mise à jour à la méthode groups.update.