Strumentare le app PHP per Error Reporting

Puoi inviare report sugli errori 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 per i seguenti casi:

• Un bucket dei log che contiene le voci di log ha chiavi di crittografia gestite dal cliente (CMEK).
• Il bucket di log soddisfa uno dei seguenti requisiti:
  • Il bucket di log è archiviato nello stesso progetto in cui hanno avuto origine 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 Functions e App Engine, Compute Engine e Google Kubernetes Engine. Error Reporting mostra gli errori 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 i dati sugli errori a Error Reporting utilizzando Logging. Per informazioni sui requisiti di formattazione dei dati, leggi Messaggi di errore di formattazione nel logging.

Prima di iniziare

Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.

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

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Enable the API

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

Go to project selector

Make sure that billing is enabled for your Google Cloud project.

Enable the Error Reporting API .

Enable the API

installa la libreria client

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

Per saperne di più sull'installazione, leggi la documentazione della libreria Error Reporting per PHP. Puoi anche segnalare i problemi utilizzando il tracker dei problemi.

Configura la libreria client

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

Eseguire app su Google Cloud

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

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

Cloud Run e Cloud Run Functions

L'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.

Ambiente flessibile di App Engine

App Engine concede automaticamente il ruolo Writer Error Reporting (roles/errorreporting.writer) al tuaccount di serviziont predefinito.

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

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

1. Installa le librerie necessarie con questo 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 delle eccezioni, consulta la sezione Integrazioni framework per ulteriori informazioni.

Google Kubernetes Engine

Per utilizzare Error Reporting con Google Kubernetes Engine, svolgi le seguenti operazioni:

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

   Puoi utilizzare l'account di servizio predefinito di Compute Engine o un account di servizio personalizzato.

   Per informazioni sulla concessione dei ruoli, consulta Gestire l'accesso a progetti, cartelle e organizzazioni.

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

   Ad esempio, il seguente comando create specifica l'ambito di accesso cloud-platform e unaccount di serviziot:

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

Compute Engine

Per utilizzare Error Reporting con le istanze VM di Compute Engine, svolgi le seguenti operazioni:

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

   Puoi utilizzare l'account di servizio predefinito di Compute Engine o un account di servizio personalizzato.

   Per informazioni sulla concessione dei ruoli, consulta Gestire 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 che deve ricevere l'cloud-platform ambito di accesso.

4. Fai clic su Interrompi 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 questo comando:

$ composer require google/cloud-error-reporting

2. Aggiungi la seguente riga al file php.ini, dove WORKSPACE è il percorso assoluto della directory principale del tuo spazio di lavoro:

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

Questo file di prefisso 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 eseguendo la libreria sulla tua workstation, devi fornire alla libreria Error Reporting per PHP le credenziali predefinite dell'applicazione locale. Per ulteriori informazioni, consulta Autenticarsi in Error Reporting.

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

1. Install the Google Cloud CLI.

2. If you're using an external identity provider (IdP), you must first sign in to the gcloud CLI with your federated identity.

3. To initialize the gcloud CLI, run the following command:

   gcloud init

4. If you're using a local shell, then create local authentication credentials for your user account:

   gcloud auth application-default login

   You don't need to do this if you're using Cloud Shell.

   If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.

Per ulteriori informazioni, vedi Set up authentication for a local development environment.

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

Visualizzazione dei rapporti degli errori

Nella console Google Cloud , vai alla pagina Error Reporting:

Vai a Error Reporting

Puoi trovare questa pagina anche utilizzando la barra di ricerca.

Per saperne di più, vedi Visualizzare gli errori.

Integrazioni del framework

Alcuni framework web sostituiscono il gestore delle eccezioni. Di seguito sono riportati esempi per l'attivazione di Error Reporting con Laravel e Symfony. Per gli altri framework, puoi utilizzare Google\Cloud\ErrorReporting\Bootstrap::exceptionHandler come gestore delle 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);
    }
}