Instrumenta apps en C# para Error Reporting

Puedes enviar informes de errores a Error Reporting desde aplicaciones de C# con el conjunto de bibliotecas Google.Cloud.Diagnostics . Usa el conjunto de bibliotecas Google.Cloud.Diagnostics para crear grupos de errores en los siguientes casos:

• Tu bucket de registros tiene claves de encriptación administradas por el cliente (CMEK).
• Tus buckets de registros no están en la región global.
• Deseas informar eventos de error personalizados.

Error Reporting está integrado a algunos servicios de Google Cloud, como App Engine, Compute Engine y Google Kubernetes Engine. Error Reporting muestra los errores que registran las aplicaciones que se ejecutan en esos servicios en Cloud Logging. Para obtener más información, ve a Ejecuta en Google Cloud en esta página.

También puedes enviar datos de errores a Error Reporting mediante Logging. Para obtener información sobre los requisitos de formato de datos, consulta Dale formato a los mensajes de error en Logging.

Antes de comenzar

1. Accede a tu cuenta de Google Cloud. Si eres nuevo en Google Cloud, crea una cuenta para evaluar el rendimiento de nuestros productos en situaciones reales. Los clientes nuevos también obtienen $300 en créditos gratuitos para ejecutar, probar y, además, implementar cargas de trabajo.

2. En la página del selector de proyectos de la consola de Google Cloud, selecciona o crea un proyecto de Google Cloud.

   Nota: Si no planeas conservar los recursos que creaste durante este procedimiento, crea un proyecto en lugar de seleccionar uno existente. Cuando termines, puedes borrar el proyecto y quitar todos los recursos asociados con él.

   Ir al selector de proyectos

3. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

4. Habilita Error Reporting API .

   Habilita la API

5. En la página del selector de proyectos de la consola de Google Cloud, selecciona o crea un proyecto de Google Cloud.

   Nota: Si no planeas conservar los recursos que creaste durante este procedimiento, crea un proyecto en lugar de seleccionar uno existente. Cuando termines, puedes borrar el proyecto y quitar todos los recursos asociados con él.

   Ir al selector de proyectos

6. Asegúrate de que la facturación esté habilitada para tu proyecto de Google Cloud.

7. Habilita Error Reporting API .

   Habilita la API

Instala la biblioteca cliente

El conjunto de bibliotecas Google.Cloud.Diagnostics te permite supervisar y ver los errores que informan las aplicaciones de C# que se ejecutan prácticamente en cualquier sitio.

1. Para las aplicaciones que se orientan a ASP.NET Core 3 o versiones posteriores, usa la biblioteca Google.Cloud.Diagnostics.AspNetCore3. Puedes instalar esta biblioteca desde NuGet.
2. Para las aplicaciones que se orientan a versiones anteriores de ASP.NET Core, usa la biblioteca Google.Cloud.Diagnostics.AspNetCore. Puedes instalar esta biblioteca desde NuGet.
3. Para las aplicaciones que se orientan a frameworks que no son de ASP.NET Core, usa la biblioteca Google.Cloud.Diagnostics.Common. Puedes instalar esta biblioteca desde NuGet.

Para obtener más información sobre la instalación, lee la documentación del conjunto de bibliotecas de Google.Cloud.Diagnostics. También puedes informar problemas con el seguimiento de problemas.

Configura la biblioteca cliente

Para obtener más información y ejemplos, consulta los siguientes recursos:

Documentación de Google.Cloud.Diagnostics.AspNetCore3

Documentación de Google.Cloud.Diagnostics.AspNetCore

Documentación de Google.Cloud.Diagnostics.Common

Ejecuta apps en Google Cloud

Para crear grupos de errores con projects.events.report, tu cuenta de servicio requiere la función de escritor de Error Reporting (roles/errorreporting.writer).

Algunos servicios de Google Cloud otorgan de forma automática la función de escritor de Error Reporting (roles/errorreporting.writer) a la cuenta de servicio adecuada. Sin embargo, debes otorgar esta función a la cuenta de servicio correspondiente para algunos servicios.

Entorno flexible de App Engine

App Engine otorga la función de escritor de Error Reporting (roles/errorreporting.writer) a la cuenta de servicio predeterminada de forma automática.

El conjunto de bibliotecas de Google.Cloud.Diagnostics se puede usar sin necesidad de proporcionar credenciales de forma explícita.

Error Reporting se habilita de forma automática en las aplicaciones del entorno flexible de App Engine. No se requiere ninguna configuración adicional. Los mensajes que se escriben desde App Engine hacia stderr se analizan y, si se descubre que contienen un seguimiento de pila, se muestran en Error Reporting.

Consulta Visualiza errores para obtener instrucciones sobre cómo ver los datos de errores y excepciones de tu aplicación en la consola de Google Cloud.

Google Kubernetes Engine

Para usar Error Reporting con Google Kubernetes Engine, haz lo siguiente:

1. Asegúrate de que a la cuenta de servicio que usará tu contenedor se le haya otorgado la función de escritor de Error Reporting (roles/errorreporting.writer).

   Puedes usar la cuenta de servicio predeterminada de Compute Engine o una cuenta de servicio personalizada.

   Para obtener información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

2. Crea tu clúster y otórgale el permiso de acceso cloud-platform.

   Por ejemplo, en el siguiente comando de creación, se especifica el permiso de acceso cloud-platform y una cuenta de servicio:

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

Nota: Después de crear un clúster, no puedes cambiar su cuenta de servicio.

Compute Engine

Para usar Error Reporting con instancias de VM de Compute Engine, haz lo siguiente:

1. Asegúrate de que a la cuenta de servicio que usará tu instancia de VM se le haya otorgado la función de escritor de Error Reporting (roles/errorreporting.writer).

   Puedes usar la cuenta de servicio predeterminada de Compute Engine o una cuenta de servicio personalizada.

   Para obtener información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

2. En el panel de navegación de la consola de Google Cloud, elige Compute Engine y, luego, Instancias de VM.

   Ir a Instancias de VM

3. Selecciona la instancia de VM en la que deseas recibir el permiso de acceso de cloud-platform.

4. Haz clic en Detener y, luego, en Editar.

5. En la sección Identidad y acceso a la API, selecciona una cuenta de servicio que tenga la función de escritor de Error Reporting (roles/errorreporting.writer).

6. En la sección Permisos de acceso, selecciona Permitir el acceso total a todas las API de Cloud y, luego, guarda los cambios.

7. Haz clic en Iniciar/Reanudar.

Ejemplo

Para obtener más información y ejemplos, consulta los siguientes recursos:

Documentación de Google.Cloud.Diagnostics.AspNetCore3

Documentación de Google.Cloud.Diagnostics.AspNetCore

Documentación de Google.Cloud.Diagnostics.Common

Ejecuta apps en un entorno de desarrollo local

Para usar el conjunto de bibliotecas Google.Cloud.Diagnostics en un entorno de desarrollo local, como ejecutar la biblioteca en tu propia estación de trabajo, debes proporcionar al conjunto de bibliotecas Google.Cloud.Diagnostics con las credenciales predeterminadas de la aplicación local. Para obtener más información, consulta Autentícate en Error Reporting.

Para usar las muestras de .NET de esta página desde un entorno de desarrollo local, instala e inicializa la CLI de gcloud y, luego, configura las credenciales predeterminadas de la aplicación con tus credenciales de usuario.

1. Instala Google Cloud CLI.

2. Para inicializar la CLI de gcloud, ejecuta el siguiente comando:

   gcloud init

3. Crea credenciales de autenticación locales para tu Cuenta de Google:

   gcloud auth application-default login

   Nota: Si la CLI de gcloud imprime una advertencia que indica que tu cuenta no tiene el permiso serviceusage.services.use, es posible que algunos comandos de la CLI de gcloud y bibliotecas cliente no funcionen. Solicita a un administrador que te otorgue el rol de IAM Consumidor de Service Usage (roles/serviceusage.serviceUsageConsumer) y, luego, ejecuta este comando:

   gcloud auth application-default set-quota-project PROJECT_ID

Para obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.

El método projects.events.report también admite claves de API. Si deseas usar claves de API para la autenticación, no necesitas configurar un archivo local de credenciales predeterminadas de la aplicación. Para obtener más información, consulta Crea una clave de API en la documentación de autenticación de Google Cloud.

Ve informes de errores

En el panel de navegación de la consola de Google Cloud, selecciona Error Reporting y, luego, tu proyecto de Google Cloud:

Ir a Error Reporting

Para obtener más información, consulta Cómo visualizar errores.