Instrument PHP apps for Error Reporting

You can send error reports to Error Reporting from PHP applications by using the Error Reporting library for PHP.

Error Reporting is integrated with some Google Cloud services, such as App Engine, Compute Engine, and Google Kubernetes Engine. Error Reporting displays the errors that are logged to Cloud Logging by applications running on those services. For more information, go to Running on Google Cloud Platform on this page.

You can also send error data to Error Reporting using Logging. For information on the data formatting requirements, read Formatting error messages in Logging.

Before you begin

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

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

   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

3. Make sure that billing is enabled for your Cloud project. Learn how to check if billing is enabled on a project.

4. Enable the Error Reporting API .

   Enable the API

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

   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

6. Make sure that billing is enabled for your Cloud project. Learn how to check if billing is enabled on a project.

7. Enable the Error Reporting API .

   Enable the API

Installing the client library

Error Reporting library for PHP lets you monitor and view errors reported by PHP applications running nearly anywhere.

For more information on installation, read the documentation for the Error Reporting library for PHP. You can also report issues using the issue tracker.

Configuring the client library

You can customize the behavior of the Error Reporting library for PHP. See the library's configuration for a list of possible configuration options.

Reporting errors

1. Install cloud libraries with the following command:

$ composer require google/cloud-error-reporting

2. Add the following line to your php.ini, where WORKSPACE is the absolute path to your workspace's root directory:

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

This prepend file installs an exception handler and an error handler which automatically send errors to Error Reporting.

If you're using App Engine flexible environment, see App Engine flexible environment on this page.

Running on Google Cloud

Using the Error Reporting library for PHP requires the Identity and Access Management Error Reporting Writer role. Most Google Cloud computing platforms provide this role by default.

You can configure Error Reporting for PHP on the following Google Cloud environments.

App Engine flexible environment

App Engine grants the Error Reporting Writer role by default.

The Error Reporting library for PHP can be used without needing to explicitly provide credentials.

To enable Error Reporting on App Engine flexible environment, follow these steps:

1. Install necessary libraries with the following command:

   $ composer require google/cloud-error-reporting

2. Add the following line to runtime_config section in app.yaml:

appengine/flexible/logging/app.yaml

View on GitHub Feedback

enable_stackdriver_integration: true

Then the library automatically collects all the errors and uncaught exceptions to Error Reporting. If you're using a Web Framework which installs its own Exception handlers, see Framework Integrations section for more information.

Google Kubernetes Engine

On GKE, you must add the cloud-platform access scope when creating the cluster, as the following example command shows:

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

Compute Engine

When using Compute Engine VM instances, add the cloud-platform access scope to each instance. When creating a new instance through the Google Cloud console, you can do this in the Identity and API access section of the Create Instance panel. Use the Compute Engine default service account or another service account of your choice, and select Allow full access to all Cloud APIs in the Identity and API access section. Whichever service account you select, ensure that it has been granted the Error Reporting Writer role in the IAM & admin section of the Google Cloud console.

Running locally and elsewhere

To use the Error Reporting library for PHP outside of Google Cloud, including running the library on your own workstation, on your data center's computers, or on the VM instances of another cloud provider, you must supply your Google Cloud project ID and appropriate service account credentials directly to the Error Reporting library for PHP.

You can create and obtain service account credentials manually. When specifying the Role field, use the Error Reporting Writer role. For more information on Identity and Access Management roles, go to Access control guide.

Viewing error reports

After deployment, you can view error reports in the Google Cloud console Error Reporting dashboard.

Go to the Error Reporting dashboard

For more information, see Viewing Errors.

Framework Integrations

Some web frameworks override the exception handler. Following are examples for enabling Error Reporting with Laravel and Symfony. For other frameworks, you can use Google\Cloud\ErrorReporting\Bootstrap::exceptionHandler as the exception handler.

Laravel

Edit the report function in the file app/Exceptions/Handler.php as follows:

appengine/standard/laravel-framework/app/Exceptions/Handler.php

View on GitHub Feedback

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

You also need to add a one-line use statement at the beginning of the file:

use Google\Cloud\ErrorReporting\Bootstrap;

Symfony

Create a new file src/AppBundle/EventSubscriber/ExceptionSubscriber.php with the following content:

appengine/flexible/symfony/src/AppBundle/EventSubscriber/ExceptionSubscriber.php

View on GitHub Feedback

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