Recopila datos de errores con Error Reporting

En este documento, se enumeran los entornos compatibles con Error Reporting y se incluyen vínculos a guías específicas de lenguaje para desarrolladores de aplicaciones. Te recomendamos que uses las bibliotecas cliente específicas del lenguaje o que te bases en las entradas de registro recopiladas automáticamente. Sin embargo, puedes escribir datos de error con la API de Cloud Logging o la API de Error Reporting. Por ejemplo, si usas Cloud Run, las excepciones escritas en stderr se envían automáticamente a Cloud Logging.

Error Reporting es un servicio global compilado en Cloud Logging y puede analizar entradas de registro cuando se cumplen todas las siguientes condiciones:

  • Las cargas de trabajo de Assured Workloads están inhabilitadas. Para obtener más información, consulta la descripción general de Assured Workloads.
  • Claves de encriptación administradas por el cliente (CMEK) está inhabilitada en todos los buckets de registro que almacenan la entrada de registro. Si deseas obtener información para determinar la configuración de CMEK de un bucket de registros, consulta Cómo verificar la habilitación de claves.
  • El bucket de registros satisface una de las siguientes opciones:
    • El bucket de registros se almacena en el mismo proyecto en el que se originaron las entradas de registro.
    • Las entradas de registro se enrutaron a un proyecto y, luego, ese proyecto las almacenó en un bucket de registros que le pertenece.
Si almacenas tus entradas de registro en buckets de registro con CMEK habilitada, puedes seguir usando Error Reporting. Sin embargo, debes usar las bibliotecas cliente de Error Reporting o la API de Error Reporting. Para obtener más información, consulta la descripción general de la API de Error Reporting y las bibliotecas cliente de Error Reporting.

Compatibilidad con la nube privada virtual

Error Reporting son un servicio compatible con la nube privada virtual (VPC).

Para reducir el riesgo de robo de datos, usa los Controles del servicio de VPC para crear un perímetro de servicio alrededor de tus servicios administrados por Google. Para obtener información sobre los Controles del servicio de VPC y cómo crear un parámetro de servicio, consulta la documentación de los Controles del servicio de VPC.

Configura entornos para informar datos de errores automáticamente

Para obtener información sobre los requisitos de configuración específicos del entorno, consulta las siguientes guías:

Instrumenta apps con bibliotecas cliente

Para obtener información sobre cómo configurar tu aplicación para que envíe informes de errores, consulta las guías de configuración específicas del idioma:

Cómo escribir datos de errores con una API

Puedes informar eventos de error a tu proyecto de Google Cloud si ejecutas el método de la API de Error Reporting report o el método de la API de Cloud Logging write.

  • Si necesitas autenticación basada en claves de API, debes usar la API de Error Reporting. Para informar un evento de error con la API de Error Reporting, ejecuta el método report y da formato al cuerpo de la solicitud del método como un objeto ReportedErrorEvent.

    Cuando usas la API de Error Reporting, las entradas de registro con mensajes de error con el formato correcto se generan y escriben automáticamente en Cloud Logging. Estas entradas de registro se escriben en un registro cuyo logName tiene el siguiente formato:

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

    Debido a que las entradas de registro se generan a través de llamadas a report, es posible que incurras en costos de transferencia de Cloud Logging. Para controlar qué entradas de registro se transfieren, consulta Filtros de exclusión.

    Si informas eventos de error con la API de Error Reporting, el resto de este documento no se aplica.

  • Si deseas usar la API de Cloud Logging, debes dar formato al objeto LogEntry para que incluya un seguimiento de pila o un objeto ReportedErrorEvent. Para obtener más información sobre los requisitos de formato, consulta Errores de formato en los registros.