Instrumenta apps de PHP para Error Reporting

Puedes enviar eventos de errores a Error Reporting desde aplicaciones de PHP con la biblioteca de Error Reporting para PHP. Usa la biblioteca de Error Reporting para PHP para crear grupos de errores en los siguientes casos:

• Un bucket de registros que contiene tus entradas de registro tiene claves de encriptación administradas por el cliente (CMEK).
• El bucket de registros satisface una de las siguientes condiciones:
  • 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 de su propiedad.
• Quieres informar eventos de errores personalizados.

Error Reporting se integra en algunos Google Cloud servicios, como Cloud Run Functions y App Engine, Compute Engine y Google Kubernetes Engine. Error Reporting muestra los eventos de error 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 eventos de errores a Error Reporting con Logging. Para obtener información sobre los requisitos de formato de datos, consulta Cómo dar formato a una entrada de registro para informar eventos de errores.

Antes de comenzar

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.

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

Roles required to select or create a project

• Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
• Create a project: To create a project, you need the Project Creator role (roles/resourcemanager.projectCreator), which contains the resourcemanager.projects.create permission. Learn how to grant roles.

Note: If you don't plan to keep the resources that you create in this procedure, create a project instead of selecting an existing project. After you finish these steps, you can delete the project, removing all resources associated with the project.

Go to project selector

Verify that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Roles required to enable APIs

To enable APIs, you need the Service Usage Admin IAM role (roles/serviceusage.serviceUsageAdmin), which contains the serviceusage.services.enable permission. Learn how to grant roles.

Enable the API

Instala la biblioteca cliente

La biblioteca de Error Reporting para PHP te permite supervisar y ver los eventos de error que informan las aplicaciones de PHP que se ejecutan en casi cualquier lugar.

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

Configura la biblioteca cliente

Puedes personalizar el comportamiento de la biblioteca d Error Reporting para PHP. Consulta la configuración de la biblioteca para obtener una lista de las opciones de configuración posibles.

Ejecuta apps en Google Cloud

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

Algunos servicios Google Cloud otorgan automáticamente el rol de Error Reporting Writer (roles/errorreporting.writer) a la cuenta de servicio adecuada. Sin embargo, debes otorgar este rol a la cuenta de servicio adecuada para algunos servicios.

Cloud Run y Cloud Run Functions

La cuenta de servicio predeterminada que usa Cloud Run tiene los permisos del rol de escritor de Error Reporting (roles/errorreporting.writer).

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

Cloud Run está configurado para usar Error Reporting automáticamente. Las excepciones de JavaScript no controladas aparecerán en Logging y Error Reporting las procesará sin necesidad de usar la biblioteca de Error Reporting para PHP.

Nota: Error Reporting crea automáticamente un evento de error cuando una entrada de registro contiene un seguimiento de pila y el nivel de gravedad de la entrada de registro no está configurado o está configurado en al menos ERROR.

Entorno flexible de App Engine

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

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

Para habilitar Error Reporting en el entorno flexible de App Engine, sigue estos pasos:

1. Instala las bibliotecas necesarias con el siguiente comando:

   $ composer require google/cloud-error-reporting

2. Agrega la siguiente línea a la sección runtime_config en app.yaml:

enable_stackdriver_integration: true

Luego, la biblioteca recopila de manera automática todos los errores y las excepciones no detectadas en Error Reporting. Si utilizas un marco de trabajo web que instala sus propios controladores de excepciones, consulta la sección de integraciones de marcos de trabajo para obtener más información.

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 el rol 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 Administración del acceso a proyectos, carpetas y organizaciones.

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

   Por ejemplo, el siguiente comando create 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 el rol 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 Administración del acceso a proyectos, carpetas y organizaciones.

2. En la consola de Google Cloud , ve a la página Instancias de VM.

   Ir a Instancias de VM

   Si usas la barra de búsqueda para encontrar esta página, selecciona el resultado cuyo subtítulo es Compute Engine.

3. Selecciona la instancia de VM que deseas que reciba el alcance de acceso 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 el rol de escritor de Error Reporting (roles/errorreporting.writer).

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

7. Haz clic en Iniciar/Reanudar.

Ejemplo

1. Instala las bibliotecas de nube con el siguiente comando:

$ composer require google/cloud-error-reporting

2. Agrega la siguiente línea al php.ini, en el que WORKSPACE es la ruta de acceso absoluta al directorio raíz de tu lugar de trabajo:

auto_prepend_file='/WORKSPACE/vendor/google/cloud-error-reporting/src/prepend.php'

Este archivo antepuesto instala un controlador de excepciones y un controlador de errores que envía errores a Error Reporting de forma automática.

Si usas el entorno flexible de App Engine, consulta Entorno flexible de App Engine en esta página.

Ejecuta apps en un entorno de desarrollo local

Para usar la biblioteca de Error Reporting para PHP en un entorno de desarrollo local, como ejecutar la biblioteca en tu propia estación de trabajo, debes proporcionar a la biblioteca de Error Reporting para PHP las credenciales predeterminadas de la aplicación local. Para obtener más información, consulta Cómo autenticarse en Error Reporting.

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

1. Instala Google Cloud CLI.

2. Si usas un proveedor de identidad (IdP) externo, primero debes acceder a gcloud CLI con tu identidad federada.

3. Si usas un shell local, crea credenciales de autenticación locales para tu cuenta de usuario:

   gcloud auth application-default login

   No es necesario que lo hagas si usas Cloud Shell.

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

   gcloud auth application-default set-quota-project PROJECT_ID

   Si se devuelve un error de autenticación y usas un proveedor de identidad (IdP) externo, confirma que accediste a la gcloud CLI con tu identidad federada.

Si deseas 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 .

Cómo ver grupos de errores

En la consola de Google Cloud , ve a la página Error Reporting:

Ir a Error Reporting

También puedes usar la barra de búsqueda para encontrar esta página.

Para obtener más información, consulta Cómo ver y filtrar grupos de errores.

Integraciones de marcos de trabajo

Algunos marcos de trabajo web anulan el controlador de excepciones. Los siguientes son ejemplos para habilitar Error Reporting con Laravel y Symfony. Para otros marcos de trabajo, puedes usar Google\Cloud\ErrorReporting\Bootstrap::exceptionHandler como el controlador de excepciones.

Laravel

Edita la función report en el archivo app/Exceptions/Handler.php de la siguiente manera:

public function report(Exception $exception)
{
    if (isset($_SERVER['GAE_SERVICE'])) {
        // Ensure Stackdriver is initialized and handle the exception
        Bootstrap::init();
        Bootstrap::exceptionHandler($exception);
    } else {
        parent::report($exception);
    }
}

También debes agregar una instrucción use de una línea al comienzo del archivo:

use Google\Cloud\ErrorReporting\Bootstrap;

Symfony

Crea un archivo nuevo src/AppBundle/EventSubscriber/ExceptionSubscriber.php con el siguiente contenido:

// src/AppBundle/EventSubscriber/ExceptionSubscriber.php
namespace AppBundle\EventSubscriber;

use Google\Cloud\ErrorReporting\Bootstrap;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\ExceptionEvent;
use Symfony\Component\HttpKernel\KernelEvents;

class ExceptionSubscriber implements EventSubscriberInterface
{
    public static function getSubscribedEvents()
    {
        // return the subscribed events, their methods and priorities
        return [KernelEvents::EXCEPTION => [
            ['logException', 0]
        ]];
    }

    public function logException(ExceptionEvent $event)
    {
        $exception = $event->getThrowable();
        Bootstrap::exceptionHandler($exception);
    }
}