Strumentare le app PHP per Error Reporting

Puoi inviare eventi di errore a Error Reporting dalle applicazioni PHP utilizzando la libreria Error Reporting per PHP. Utilizza la libreria Error Reporting per PHP per creare gruppi di errori nei seguenti casi:

• Un bucket di log che contiene le voci di log ha chiavi di crittografia gestite dal cliente (CMEK).
• Il bucket di log soddisfa una delle seguenti condizioni:
  • Il bucket di log è archiviato nello stesso progetto in cui sono state create le voci di log.
  • Le voci di log sono state instradate a un progetto, che le ha archiviate in un bucket di log di sua proprietà.
• Vuoi segnalare eventi di errore personalizzati.

Error Reporting è integrato con alcuni Google Cloud servizi, come Cloud Run Functions e App Engine, Compute Engine e Google Kubernetes Engine. Error Reporting mostra gli eventi di errore registrati in Cloud Logging dalle applicazioni in esecuzione su questi servizi. Per saperne di più, vai a Esecuzione su Google Cloud in questa pagina.

Puoi anche inviare eventi di errore a Error Reporting utilizzando Logging. Per informazioni sui requisiti di formattazione dei dati, consulta Formattare una voce di log per segnalare eventi di errore.

Prima di iniziare

1. 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

2. Verify that billing is enabled for your Google Cloud project.

3. Enable the Error Reporting API .

   Roles required to enable APIs

   To enable APIs, you need the serviceusage.services.enable permission. If you created the project, then you likely already have this permission through the Owner role (roles/owner). Otherwise, you can get this permission through the Service Usage Admin role (roles/serviceusage.serviceUsageAdmin). Learn how to grant roles.

   Enable the API

Installa la libreria client

La libreria Error Reporting per PHP consente di monitorare e visualizzare gli eventi di errore segnalati dalle applicazioni PHP in esecuzione praticamente ovunque.

Per saperne di più sull'installazione, consulta la documentazione della libreria Error Reporting per PHP. Puoi anche segnalare i problemi utilizzando lo strumento di monitoraggio dei problemi.

Configura la libreria client

Puoi personalizzare il comportamento della libreria Error Reporting per PHP. Per un elenco delle possibili opzioni di configurazione, consulta la configurazione della libreria.

Esegui app su Google Cloud

Per creare gruppi di errori utilizzando projects.events.report, il tuo account di servizio richiede il ruolo Writer di Error Reporting (roles/errorreporting.writer).

Alcuni Google Cloud servizi concedono automaticamente il ruolo Writer di Error Reporting (roles/errorreporting.writer) al account di servizio appropriato. Tuttavia, per alcuni servizi devi concedere questo ruolo al service account appropriato.

Cloud Run e Cloud Run Functions

Il account di servizio predefinito utilizzato da Cloud Run dispone delle autorizzazioni del ruolo Writer di Error Reporting (roles/errorreporting.writer).

La libreria Error Reporting per PHP può essere utilizzata senza dover fornire esplicitamente le credenziali.

Cloud Run è configurato per utilizzare Error Reporting automaticamente. Le eccezioni JavaScript non gestite verranno visualizzate in Logging ed elaborate da Error Reporting senza dover utilizzare la libreria Error Reporting per PHP.

Nota: Error Reporting crea automaticamente un evento di errore quando una voce di log contiene un'analisi dello stack e il livello di gravità della voce di log non è impostato o è impostato su almeno ERROR.

Ambiente flessibile di App Engine

App Engine concede automaticamente il ruolo Writer di Error Reporting (roles/errorreporting.writer) al tuo account di servizio predefinito.

La libreria Error Reporting per PHP può essere utilizzata senza dover fornire esplicitamente le credenziali.

Per abilitare Error Reporting nell'ambiente flessibile di App Engine:

1. Installa le librerie necessarie con il seguente comando:

   $ composer require google/cloud-error-reporting

2. Aggiungi la seguente riga alla sezione runtime_config in app.yaml:

enable_stackdriver_integration: true

La libreria raccoglie automaticamente tutti gli errori e le eccezioni non rilevate in Error Reporting. Se utilizzi un framework web che installa i propri gestori di eccezioni, consulta la sezione Integrazioni del framework per ulteriori informazioni.

Google Kubernetes Engine

Per utilizzare Error Reporting con Google Kubernetes Engine:

1. Assicurati che al account di servizio da utilizzare dal container sia stato concesso il ruolo Writer di Error Reporting (roles/errorreporting.writer).

   Puoi utilizzare il service account predefinito di Compute Engine o un account di servizio personalizzato.

   Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

2. Crea il cluster e concedi al cluster l' cloud-platform ambito di accesso.

   Ad esempio, il seguente comando create specifica l'ambito di accesso cloud-platform e un account di servizio:

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

Nota: dopo aver creato un cluster, non puoi modificarne il service account.

Compute Engine

Per utilizzare Error Reporting con le istanze VM di Compute Engine:

1. Assicurati che al account di servizio da utilizzare dall'istanza VM sia stato concesso il ruolo Writer di Error Reporting (roles/errorreporting.writer).

   Puoi utilizzare il service account predefinito di Compute Engine o un account di servizio personalizzato.

   Per saperne di più sulla concessione dei ruoli, consulta Gestisci l'accesso a progetti, cartelle e organizzazioni.

2. Nella Google Cloud console, vai alla pagina Istanze VM:

   Vai a Istanze VM

   Se utilizzi la barra di ricerca per trovare questa pagina, seleziona il risultato con il sottotitolo Compute Engine.

3. Seleziona l'istanza VM a cui vuoi concedere l' cloud-platform ambito di accesso.

4. Fai clic su Arresta e poi su Modifica.

5. Nella sezione Identità e accesso API, seleziona un account di servizio con il ruolo Writer di Error Reporting (roles/errorreporting.writer).

6. Nella sezione Ambiti di accesso, seleziona Consenti l'accesso completo a tutte le API Cloud e salva le modifiche.

7. Fai clic su Avvia/Riprendi.

Esempio

1. Installa le librerie cloud con il seguente comando:

$ composer require google/cloud-error-reporting

2. Aggiungi la seguente riga a php.ini, dove WORKSPACE è il percorso assoluto della directory principale dell'area di lavoro:

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

Questo file di anteposizione installa un gestore di eccezioni e un gestore di errori che inviano automaticamente gli errori a Error Reporting.

Se utilizzi l'ambiente flessibile di App Engine, consulta la sezione Ambiente flessibile di App Engine in questa pagina.

Esegui app in un ambiente di sviluppo locale

Per utilizzare la libreria Error Reporting per PHP in un ambiente di sviluppo locale, ad esempio eseguendola sulla tua workstation, devi fornire alla libreria Error Reporting per PHP le credenziali predefinite dell'applicazione locale. Per saperne di più, consulta Autenticarsi a Error Reporting.

Per utilizzare gli esempi PHP in questa pagina in un ambiente di sviluppo locale, installa e inizializza gcloud CLI, quindi configura Credenziali predefinite dell'applicazione con le tue credenziali utente.

1. Installa Google Cloud CLI.

2. Configura gcloud CLI per utilizzare la tua identità federata.

   Per ulteriori informazioni, vedi Accedi a gcloud CLI con la tua identità federata.

3. Crea le credenziali di autenticazione locali per il tuo account utente:

   gcloud auth application-default login

   Nota: se gcloud CLI stampa un avviso che indica che il tuo account non dispone dell'autorizzazione serviceusage.services.use, alcuni comandi gcloud CLI e librerie client potrebbero non funzionare. Chiedi a un amministratore di concederti il ruolo IAM Consumer di utilizzo del servizio (roles/serviceusage.serviceUsageConsumer), quindi esegui il seguente comando:

   gcloud auth application-default set-quota-project PROJECT_ID

   Se viene restituito un errore di autenticazione e utilizzi un provider di identità (IdP) esterno, verifica di aver acceduto a gcloud CLI con la tua identità federata.

Per saperne di più, consulta Configura l'autenticazione per un ambiente di sviluppo locale.

Il metodo projects.events.report supporta anche le chiavi API. Se vuoi utilizzare le chiavi API per l'autenticazione, non devi configurare un file di Credenziali predefinite dell'applicazione locale. Per saperne di più, consulta Crea una chiave API nella Google Cloud documentazione sull'autenticazione di.

Visualizza i gruppi di errori

Nella Google Cloud console, vai alla pagina Error Reporting:

Vai a Error Reporting

Puoi trovare questa pagina anche utilizzando la barra di ricerca.

Per saperne di più, consulta Visualizzare e filtrare i gruppi di errori.

Integrazioni del framework

Alcuni framework web sostituiscono il gestore di eccezioni. Di seguito sono riportati esempi di abilitazione di Error Reporting con Laravel e Symfony. Per altri framework, puoi utilizzare Google\Cloud\ErrorReporting\Bootstrap::exceptionHandler come gestore di eccezioni.

Laravel

Modifica la funzione report nel file app/Exceptions/Handler.php come segue:

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

Devi anche aggiungere un'istruzione use di una riga all'inizio del file:

use Google\Cloud\ErrorReporting\Bootstrap;

Symfony

Crea un nuovo file src/AppBundle/EventSubscriber/ExceptionSubscriber.php con il seguente contenuto:

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