Updates error reporting samples and fixes tests (GoogleCloudPlatform#802)

Author: bshaffer

error_reporting/README.md

@@ -12,14 +12,17 @@ exceptions, errors, and PHP fatral errors to Stackdriver Error Reporting.
 
 1. To use this sample, you must first [enable the Stackdriver Error Reporting API][0]
 1. Next, **Install dependencies** via [Composer](http://getcomposer.org/doc/00-intro.md):
-    1. Run `php composer.phar install --ignore-platform-reqs` (if composer is installed locally) or `composer install --ignore-platform-reqs`
+    1. Run `php composer.phar install` (if composer is installed locally) or `composer install`
     (if composer is installed globally).
     ```sh
-    composer install --ignore-platform-reqs
+    composer install
+    ```
+    1. To use the [gRPC PHP Extension][php_grpc], which will be more performant than
+    REST/HTTP,
+    install and enable the gRPC extension using PECL:
+    ```sh
+    pecl install grpc
     ```
-    1. If the [gRPC PHP Extension][php_grpc] is enabled for your version of PHP,
-    install your dependencies without the `--ignore-platform-reqs` flag. **Note**
-    some samples in `error_reporting.php` require gRPC.
 1. Create a service account in the [Service Account section of the Cloud Console][2]
 1. Download the JSON key file of the service account.
 1. Set `GOOGLE_APPLICATION_CREDENTIALS` environment variable to point to that file.
@@ -36,41 +39,31 @@ Run the samples:
 
 ```sh
 php quickstart.php
-Exception logged to Stackdriver Error Reporting
+Throwing a test exception. You can view the message at https://console.cloud.google.com/errors.
 ```
 
-View [Stackdriver Error Reporting][1] in the Cloud Console to see the logged
-exception.
+This example registers the Stackdriver exception handler using
+[PHP exception handlers][3]. View [Stackdriver Error Reporting][1] in the Cloud
+Console to see the logged exception.
 
-# Running error_reporting.php
+# Running src/report_error.php
 
-Run the sample:
-
-```sh
-$ php error_reporting.php report YOUR_PROJECT_ID
-Reported an error to Stackdriver
-```
+This sample shows how to report an error by creating a `ReportedErrorEvent`. The
+`ReportedErrorEvent` object gives you more control over how the error appears
+and the details associated with it.
 
-For an example of how to register the Stackdriver exception handler in your custom application, see
-[src/register_exception_handler.php](src/register_exception_handler.php). You can test this out
-using the samples:
+Run the sample:
 
 ```sh
-# Test registering an exception handler and then throwing a PHP Fatal Error
-$ php error_reporting.php test-exception-handler YOUR_PROJECT_ID --fatal
-Triggering a PHP Fatal Error by eval-ing a syntax error...
+$ php src/report_error.php YOUR_PROJECT_ID "This is a test message"
+Reported an exception to Stackdriver
 ```
 
-For more granular control over your error reporting, and better performance, you can use the gRPC
-library to throw errors. Follow the instructions to install and enable the
-[gRPC PHP Extension][php_grpc]. Now run the gRPC example in `error_reporting.php`:
-
-```sh
-$ php error_reporting.php report-grpc YOUR_PROJECT_ID
-Reported an error to Stackdriver
-```
+View [Stackdriver Error Reporting][1] in the Cloud Console to see the logged
+exception.
 
 [0]: https://console.cloud.google.com/flows/enableapi?apiid=clouderrorreporting.googleapis.com
 [1]: https://console.cloud.google.com/errors
 [2]: https://console.cloud.google.com/iam-admin/serviceaccounts/
-[php_grpc]: http://cloud.google.com/php/grpc
+[3]: http://php.net/manual/en/function.set-exception-handler.php
+[php_grpc]: http://cloud.google.com/php/grpc

error_reporting/composer.json

@@ -1,16 +1,9 @@
 {
     "require": {
-        "google/cloud-error-reporting": "^0.8",
-        "symfony/console": " ^3.3",
-        "symfony/event-dispatcher": "^3.3"
+        "google/cloud-error-reporting": "^0.12.3"
     },
     "require-dev": {
         "phpunit/phpunit": "~4.8",
-        "google/cloud-tools": "^0.6.9"
-    },
-    "autoload-dev": {
-        "psr-4": {
-            "Google\\Cloud\\Samples\\ErrorReporting\\": "test"
-        }
+        "google/cloud-tools": "^0.8.5"
     }
 }

error_reporting/error_reporting.php

@@ -5,42 +5,30 @@
 
 # [START error_reporting_quickstart]
 // Imports the Cloud Client Library
+use Google\Cloud\ErrorReporting\Bootstrap;
 use Google\Cloud\Logging\LoggingClient;
+use Google\Cloud\Core\Report\SimpleMetadataProvider;
 
 // These variables are set by the App Engine environment. To test locally,
 // ensure these are set or manually change their values.
 $projectId = getenv('GCLOUD_PROJECT') ?: 'YOUR_PROJECT_ID';
 $service = getenv('GAE_SERVICE') ?: 'error_reporting_quickstart';
-$version = getenv('GAE_VERSION') ?: '1.0-dev';
+$version = getenv('GAE_VERSION') ?: 'test';
 
 // Instantiates a client
 $logging = new LoggingClient([
-    'projectId' => $projectId
+    'projectId' => $projectId,
 ]);
+// Set the projectId, service, and version via the SimpleMetadataProvider
+$metadata = new SimpleMetadataProvider([], $projectId, $service, $version);
+// Create a PSR-4 compliant logger
+$psrLogger = $logging->psrLogger('error-log', [
+    'metadataProvider' => $metadata,
+]);
+// Using the Error Reporting Bootstrap class, register your PSR logger as a PHP
+// exception hander. This will ensure all exceptions are logged to Stackdriver.
+Bootstrap::init($psrLogger);
 
-// The name of the log to write to
-$logName = 'my-log';
-
-// Selects the log to write to
-$logger = $logging->logger($logName);
-
-$handlerFunction = function (Exception $e) use ($logger, $service, $version) {
-    // Creates the log entry with the exception trace
-    $entry = $logger->entry([
-        'message' => sprintf('PHP Warning: %s', $e),
-        'serviceContext' => [
-            'service' => $service,
-            'version' => $version,
-        ]
-    ]);
-    // Writes the log entry
-    $logger->write($entry);
-
-    print("Exception logged to Stackdriver Error Reporting" . PHP_EOL);
-};
-
-// Sets PHP's default exception handler
-set_exception_handler($handlerFunction);
-
-throw new Exception('This will be logged to Stackdriver Error Reporting');
+print("Throwing a test exception. You can view the message at https://console.cloud.google.com/errors." . PHP_EOL);
+throw new Exception('quickstart.php test exception');
 # [END error_reporting_quickstart]