Recueillir les données relatives aux erreurs à l'aide d'Error Reporting

Ce document liste les environnements compatibles avec Error Reporting, ainsi que des liens vers des guides spécifiques aux langages pour les développeurs d'applications. Nous vous recommandons d'utiliser les bibliothèques clientes spécifiques à chaque langage ou des journaux collectés automatiquement. Toutefois, vous pouvez écrire des données d'erreur avec l'API Cloud Logging ou Error Reporting. Par exemple, si vous utilisez Cloud Run, les exceptions écrites dans stderr sont automatiquement envoyées à Cloud Logging.

Error Reporting est un service global qui analyse automatiquement les journaux de votre projet Google Cloud pour identifier les erreurs. Toutefois, Error Reporting peut uniquement analyser les entrées de journal stockées dans les buckets Cloud Logging situés dans la région global, où les projets Google Cloud source et de destination sont identiques, et où les clés de chiffrement gérées par le client (CMEK) sont désactivées. Si vous acheminez les journaux vers un autre projet Google Cloud, dans des buckets régionalisés ou si vous activez les CMEK, Error Reporting ne capture ni n'analyse ces journaux. Pour savoir comment vérifier la configuration de vos buckets de journaux, consultez la page Dépannage.

Compatibilité avec le cloud privé virtuel

Error Reporting est un service compatible avec le cloud privé virtuel (VPC).

Pour réduire le risque d'exfiltration des données, utilisez VPC Service Controls pour créer un périmètre de service autour de vos services gérés par Google. Pour en savoir plus sur VPC Service Controls et sur la création d'un paramètre de service, consultez la documentation de VPC Service Controls.

Configurer les environnements pour signaler automatiquement les données d'erreur

Pour en savoir plus sur les exigences de configuration spécifiques aux environnements, consultez les guides suivants:

Instrumentez des applications à l'aide de bibliothèques clientes

Pour savoir comment configurer votre application pour envoyer des rapports d'erreurs, consultez les guides de configuration par langage:

Écrire des données d'erreur à l'aide d'une API

Vous pouvez signaler les événements d'erreur à votre projet Google Cloud en exécutant la méthode de l'API Error Reporting report ou la méthode de l'API Cloud Logging write.

  • Si vous avez besoin d'une authentification basée sur des clés API, vous devez utiliser l'API Error Reporting. Pour signaler un événement d'erreur à l'aide de l'API Error Reporting, exécutez la méthode report et mettez en forme le corps de la requête en tant qu'objet ReportedErrorEvent.

    Lorsque vous utilisez l'API Error Reporting, les entrées de journal contenant des messages d'erreur correctement formatés sont automatiquement générées et écrites dans Cloud Logging. Ces entrées de journal sont écrites dans un journal dont le logName est formaté comme suit:

    projects/PROJECT_ID/clouderrorreporting.googleapis.com%2Freported_errors
    

    Les entrées de journal étant générées par des appels à report, des coûts d'ingestion dans Cloud Logging peuvent s'appliquer. Pour contrôler les journaux ingérés, consultez la section Filtres d'exclusion.

    Si vous signalez des événements associés à des erreurs à l'aide de l'API Error Reporting, le reste de ce document ne s'applique pas.

  • Si vous souhaitez utiliser l'API Cloud Logging, vous devez mettre en forme l'objet LogEntry afin d'inclure une trace de la pile ou un objet ReportedErrorEvent. Pour en savoir plus sur les exigences de mise en forme, consultez la section Erreurs de mise en forme dans les journaux.