Enabling the library

Setting Up Stackdriver Error Reporting for PHP

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

Stackdriver Error Reporting is integrated with some products, such as App Engine. Stackdriver Error Reporting displays the errors that are logged to Stackdriver Logging by applications running on those products. See Running on Google Cloud Platform for more information.

Before you begin

  1. Sign in to your Google Account.

    If you don't already have one, sign up for a new account.

  2. Select or create a GCP project.

    Go to the Manage resources page

  3. Make sure that billing is enabled for your project.

    Learn how to enable billing

  4. Enable the Stackdriver Error Reporting API.

    Enable the API

Installing the client library

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

For more information on installation, see the documentation for the Stackdriver 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 Stackdriver 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-logging google/cloud-error-reporting
1. Add the following line to your php.ini:
auto_prepend_file='/project-dir/vendor/google/cloud-error-reporting/src/prepend.php'
1. Set GOOGLE_CLOUD_PROJECT environment variable to your project name.

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

Running on Google Cloud Platform

Using the Stackdriver Error Reporting library for PHP requires the Cloud IAM Error Reporting Writer role. Most Google Cloud Platform computing platforms provide this role by default.

App Engine flexible environment

Google App Engine grants the Error Reporting Writer role by default.

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

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

  1. Install necessary libraries with the following command

    $ composer require google/cloud-logging google/cloud-error-reporting

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

enable_stackdriver_integration: true

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

Kubernetes Engine

On Google Kubernetes Engine, 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 Google Compute Engine VM instances, add the cloud-platform access scope to each instance. When creating a new instance through the Google Cloud Platform 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 GCP Console.

Running locally and elsewhere

To use the Stackdriver Error Reporting library for PHP outside of Google Cloud Platform, you must supply your GCP project ID and appropriate service account credentials directly to the Stackdriver Error Reporting library for PHP. This applies to running the library on your own workstation, on your data center's computers, or on the VM instances of another cloud provider. For more information see Obtaining and providing service account credentials manually.

Viewing error reports

After deployment, you can view error reports in the GCP 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 Symfony and Laravel. For other frameworks, you can use Google\Cloud\ErrorReporting\Bootstrap::exceptionHandler as the exception handler.

Symfony

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

<?php

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

Laravel

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

public function report(Exception $exception)
{
    if (isset($_SERVER['GAE_SERVICE'])) {
        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;
Was this page helpful? Let us know how we did:

Send feedback about...

Stackdriver Error Reporting