Instrumenta las apps de PHP para Error Reporting

Cómo habilitar la biblioteca

Puedes enviar informes de errores a Error Reporting desde aplicaciones PHP mediante la biblioteca de Error Reporting para PHP. Usa la biblioteca de Error Reporting para PHP con el objetivo de 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

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.

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

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

Habilita Error Reporting API .

Habilita la API

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

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

Habilita Error Reporting API .

Habilita la API

Instala la biblioteca cliente

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

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.

Cómo configurar 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 de Google Cloud otorgan automáticamente 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 automáticamente la función de escritor de Error Reporting (roles/errorreporting.writer) a la 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:

Instala las bibliotecas necesarias con el siguiente comando:
```
$ composer require google/cloud-error-reporting
```
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:

Asegúrate de que la cuenta de servicio que usa el contenedor tenga la función de escritor de Error Reporting (roles/errorreporting.writer).

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

Para obtener información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.
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:

Asegúrate de que la cuenta de servicio que usará tu instancia de VM tenga la función de escritor de Error Reporting (roles/errorreporting.writer).

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

Para obtener información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.
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
Selecciona la instancia de VM que deseas que reciba el permiso de acceso de cloud-platform.
Haz clic en Detener y, luego, en Editar.
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).
En la sección Permisos de acceso, selecciona Permitir el acceso total a todas las APIs de Cloud y, luego, guarda los cambios.
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

Si deseas 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 la biblioteca de Error Reporting para PHP con las credenciales predeterminadas de la aplicación local. Si deseas obtener más información, consulta Autentícate en Error Reporting.

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

Instala Google Cloud CLI.
Para inicializar la CLI de gcloud, ejecuta el siguiente comando:
```
gcloud init
```

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.

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);
    }
}