Configurer Error Reporting pour PHP

Activer la bibliothèque

Vous pouvez envoyer des rapports d'erreurs à Error Reporting depuis des applications PHP à l'aide de la bibliothèque Error Reporting pour PHP.

Error Reporting est intégré à certains services Google Cloud, tels que App Engine, Compute Engine et Google Kubernetes Engine. Error Reporting vous permet d'afficher les erreurs qui sont consignées dans Cloud Logging par les applications exécutées sur ces services. Pour en savoir plus, consultez la section Exécuter sur Google Cloud Platform de cette page.

Vous pouvez également envoyer des données d'erreur à Error Reporting à l'aide de Logging. Pour en savoir plus sur les exigences en matière de mise en forme des données, consultez la page Formater les messages d'erreur dans Logging.

Avant de commencer

  1. Connectez-vous à votre compte Google.

    Si vous n'en possédez pas déjà un, vous devez en créer un.

  2. Dans Cloud Console, sur la page de sélection du projet, sélectionnez ou créez un projet Cloud.

    Accéder à la page de sélection du projet

  3. Vérifiez que la facturation est activée pour votre projet Google Cloud. Découvrez comment vérifier que la facturation est activée pour votre projet.

  4. Activez Error Reporting API .

    Activer l'API

Installer la bibliothèque cliente

La bibliothèque Error Reporting pour PHP vous permet de surveiller et d'afficher les erreurs signalées par les applications PHP exécutées depuis presque n'importe quel emplacement.

Pour en savoir plus sur l'installation, consultez la documentation sur la bibliothèque Error Reporting pour PHP. Vous pouvez également signaler d'éventuels problèmes à l'aide de l'outil de suivi des problèmes.

Configurer la bibliothèque cliente

Vous pouvez personnaliser le comportement de la bibliothèque Error Reporting pour PHP. Consultez la configuration de la bibliothèque pour afficher la liste des options de configuration possibles.

Signaler des erreurs

1. Installez les bibliothèques cloud avec la commande suivante :

$ composer require google/cloud-error-reporting
1. Ajoutez la ligne suivante au fichier php.ini, où PROJECT_DIR correspond au chemin absolu du répertoire racine de votre projet :
auto_prepend_file='PROJECT_DIR/vendor/google/cloud-error-reporting/src/prepend.php'
1. Définissez la variable d'environnement GOOGLE_CLOUD_PROJECT sur le nom de votre projet Google Cloud.

Ce fichier ajoute un gestionnaire d'exceptions et un gestionnaire d'erreurs qui envoient automatiquement des erreurs à Error Reporting.

Exécuter des applications sur Google Cloud

L'utilisation de la bibliothèque Error Reporting pour PHP nécessite de disposer du rôle Cloud Identity and Access Management de rédacteur pour Error Reporting. La plupart des plates-formes de calcul Google Cloud attribuent ce rôle par défaut.

Vous pouvez configurer Error Reporting pour PHP sur les environnements Google Cloud suivants.

Environnement flexible App Engine

App Engine attribue par défaut le rôle de rédacteur pour Error Reporting.

La bibliothèque Error Reporting pour PHP peut être utilisée sans avoir à fournir explicitement des identifiants.

Pour activer Error Reporting dans l'environnement flexible App Engine, procédez comme suit :

  1. Installez les bibliothèques nécessaires avec la commande suivante :

    $ composer require google/cloud-error-reporting
  2. Ajoutez la ligne suivante à la section runtime_config du fichier app.yaml :

enable_stackdriver_integration: true

La bibliothèque collecte ensuite automatiquement toutes les erreurs et exceptions non interceptées dans Error Reporting. Si vous utilisez un framework Web qui installe ses propres gestionnaires d'exceptions, consultez la section Intégrations de framework pour en savoir plus.

Google Kubernetes Engine

Sur GKE, vous devez ajouter le niveau d'accès cloud-platform lors de la création du cluster, comme indiqué dans l'exemple de commande ci-dessous :

gcloud container clusters create example-cluster-name --scopes https://www.googleapis.com/auth/cloud-platform

Instance

Lorsque vous utilisez des instances de VM Compute Engine, ajoutez le niveau d'accès cloud-platform à chaque instance. Lorsque vous créez une instance via Google Cloud Console, vous pouvez le faire dans la section Identité et accès à l'API du panneau Créer une instance. Utilisez le compte de service par défaut de Compute Engine ou un autre compte de service de votre choix, puis sélectionnez Autoriser l'accès complet à l'ensemble des API Cloud dans la section Identité et accès à l'API. Quel que soit le compte de service sélectionné, vérifiez qu'il dispose du rôle Rédacteur Error Reporting dans la section IAM et administration de Cloud Console.

Exécuter en local et depuis un autre emplacement

Pour utiliser la bibliothèque Error Reporting pour PHP en dehors de Google Cloud, y compris en l'exécutant sur votre propre poste de travail, sur les ordinateurs de votre centre de données ou sur les instances de VM d'un autre fournisseur cloud, vous devez saisir l'ID de projet Google Cloud ainsi que les identifiants du compte de service approprié directement dans la bibliothèque Error Reporting pour PHP.

Vous pouvez créer et obtenir manuellement des identifiants pour le compte de service. Lorsque vous spécifiez le champ Rôle, utilisez le rôle Rédacteur Error Reporting. Pour en savoir plus sur les rôles IAM (Identity and Access Management), consultez le guide du contrôle des accès.

Afficher les rapports d'erreurs

Après le déploiement, vous pouvez afficher les rapports d'erreurs dans le tableau de bord Error Reporting de Cloud Console.

Accéder au tableau de bord Error Reporting

Pour en savoir plus, consultez la page Afficher les erreurs.

Intégrations de framework

Certains framework Web remplacent le gestionnaire d'exceptions. Vous trouverez ci-dessous des exemples où Error Reporting est activé avec Laravel et Symfony. Pour les autres frameworks, vous pouvez utiliser Google\Cloud\ErrorReporting\Bootstrap::exceptionHandler comme gestionnaire d'exceptions.

Laravel

Modifiez la fonction report dans le fichier app/Exceptions/Handler.php, comme suit :

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

Vous devez également ajouter une instruction use d'une ligne au début du fichier :

use Google\Cloud\ErrorReporting\Bootstrap;

Symfony

Créez un fichier src/AppBundle/EventSubscriber/ExceptionSubscriber.php avec le contenu suivant :

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

use Google\Cloud\ErrorReporting\Bootstrap;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
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(GetResponseForExceptionEvent $event)
    {
        $exception = $event->getException();
        Bootstrap::exceptionHandler($exception);
    }
}