Instrumenta las apps de Python para Error Reporting

Puedes enviar informes de errores a Error Reporting desde aplicaciones de Python mediante la biblioteca de Error Reporting para Python. Usa la biblioteca de Error Reporting para Python a fin de crear grupos de errores para 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.

    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.

    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

  8. Prepara tu entorno para el desarrollo en Python.

    Ir a la guía de configuración de Python

Instala la biblioteca cliente

La biblioteca de Error Reporting para Python te permite supervisar y ver errores que informan las aplicaciones de Python que se ejecutan prácticamente en cualquier sitio.

  1. Crea una instancia para un entorno virtual y usa pip a fin de instalar el paquete:

    pip install google-cloud-error-reporting --upgrade
    
  2. Importa la biblioteca y crea una instancia de cliente para comenzar a informar errores:

    Python

    Para autenticarte en Error Reporting, configura las credenciales predeterminadas de la aplicación. Si deseas obtener más información, consulta Configura la autenticación para un entorno de desarrollo local.

    #!/usr/bin/env python
    #
    # Copyright 2022 Google, Inc.
    #
    # Licensed under the Apache License, Version 2.0 (the "License");
    # you may not use this file except in compliance with the License.
    # You may obtain a copy of the License at
    #
    #    http://www.apache.org/licenses/LICENSE-2.0
    #
    # Unless required by applicable law or agreed to in writing, software
    # distributed under the License is distributed on an "AS IS" BASIS,
    # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    # See the License for the specific language governing permissions and
    # limitations under the License.
    
    def report_exception():
        from google.cloud import error_reporting
    
        client = error_reporting.Client()
        try:
            raise Exception("Something went wrong")
        except Exception:
            client.report_exception()
    
    def report_manual_error():
        from google.cloud import error_reporting
    
        client = error_reporting.Client()
        client.report("An error has occurred.")
    
    if __name__ == "__main__":
        report_exception()
        report_manual_error()
    

A fin de obtener más información sobre la instalación, lee la documentación de la biblioteca de Error Reporting para Python. También puedes informar problemas con el seguimiento de problemas.

Configura la biblioteca cliente

Puedes personalizar el comportamiento de la biblioteca de Error Reporting para Python. Consulta la documentación de la biblioteca cliente para obtener ejemplos de configuración.

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.

La biblioteca de Error Reporting para Python se puede usar sin necesidad de proporcionar credenciales de forma explícita.

Error Reporting se habilita de manera automática para las aplicaciones del entorno flexible de App Engine. No se requiere ninguna configuración adicional.

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
    

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 informar un error de forma manual, llama al método report, como se muestra en el siguiente ejemplo:

Python

Para autenticarte en Error Reporting, configura las credenciales predeterminadas de la aplicación. Para obtener más información, consulta Configura la autenticación.

#!/usr/bin/env python
#
# Copyright 2022 Google, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

def report_exception():
    from google.cloud import error_reporting

    client = error_reporting.Client()
    try:
        raise Exception("Something went wrong")
    except Exception:
        client.report_exception()

def report_manual_error():
    from google.cloud import error_reporting

    client = error_reporting.Client()
    client.report("An error has occurred.")

if __name__ == "__main__":
    report_exception()
    report_manual_error()

Ejecuta apps en un entorno de desarrollo local

Si quieres usar la biblioteca de Error Reporting para Python en un entorno de desarrollo local, como ejecutar la biblioteca en tu propia estación de trabajo, debes proporcionar las credenciales predeterminadas de la aplicación local a tu biblioteca de Error Reporting para Python. Para obtener más información, consulta Autentícate en Error Reporting.

Para usar las muestras de Python 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

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.