Add Stackdriver for App Engine Standard / PHP 72 (GoogleCloudPlatform#796)

Author: bshaffer

appengine/php72/laravel-framework/README.md

@@ -122,6 +122,92 @@ Laravel, you need to manually add the `DB_SOCKET` value to
 1. Replace each instance of `YOUR_DB_PASSWORD` and `YOUR_CONNECTION_NAME`
    with the values you created for your Cloud SQL instance above.
 
+## Set up Stackdriver Logging and Error Reporting
+
+Before we begin, install both of the Google Cloud client libraries for Stackdriver
+Logging and Error Reporting:
+
+        composer require google/cloud-logging google/cloud-error-reporting
+
+### Stackdriver Logging
+
+You can write logs to Stackdriver Logging from PHP applications by using the Stackdriver Logging library for PHP directly.
+
+1. First, create a custom logger in `app/Logging/CreateCustomLogger.php`:
+    ```php
+    namespace App\Logging;
+
+    use Google\Cloud\Logging\LoggingClient;
+    use Monolog\Handler\PsrHandler;
+    use Monolog\Logger;
+
+    class CreateCustomLogger
+    {
+        /**
+         * Create a custom Monolog instance.
+         *
+         * @param  array  $config
+         * @return \Monolog\Logger
+         */
+        public function __invoke(array $config)
+        {
+            $logName = isset($config['logName']) ? $config['logName'] : 'app';
+            $psrLogger = LoggingClient::psrBatchLogger($logName);
+            $handler = new PsrHandler($psrLogger);
+            $logger = new Logger($logName, [$handler]);
+            return $logger;
+        }
+    }
+    ```
+
+1. Next, you'll need to add our new custom logger to `config/logging.php`:
+
+    ```php
+    'channels' => [
+
+        // Add the following lines to integrate with Stackdriver:
+        'stackdriver' => [
+            'driver' => 'custom',
+            'via' => App\Logging\CreateCustomLogger::class,
+            'level' => 'debug',
+        ],
+    ```
+
+1. Now you can log to Stackdriver logging anywhere in your application!
+
+    ```php
+    Log::info("Hello Stackdriver! This will show up as log level INFO!");
+    ```
+
+### Stackdriver Error Reporting
+
+You can send error reports to Stackdriver Error Reporting from PHP applications by using the
+[Stackdriver Error Reporting library for PHP](http://googleapis.github.io/google-cloud-php/#/docs/cloud-error-reporting/v0.12.3/errorreporting/readme).
+
+
+1. Add the following `use` statement at the beginning of the file `app/Exceptions/Handler.php`:
+    ```php
+    use Google\Cloud\ErrorReporting\Bootstrap;
+    ```
+
+1. Edit the `report` function in the same file (`app/Exceptions/Handler.php`) as follows:
+    ```php
+    public function report(Exception $exception)
+    {
+        if (isset($_SERVER['GAE_SERVICE'])) {
+            Bootstrap::init();
+            Bootstrap::exceptionHandler($exception);
+        } else {
+            parent::report($exception);
+        }
+    }
+    ```
+
+1. Now any PHP Exception will be logged to Stackdriver Error Reporting!
+    ```php
+    throw new \Exception('PHEW! We will see this in Stackdriver Error Reporting!');
+    ```
+
 [php-gcp]: https://cloud.google.com/php
 [laravel]: http://laravel.com
 [laravel-install]: https://laravel.com/docs/5.4/installation

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

@@ -0,0 +1,62 @@
+
+
+namespace App\Exceptions;
+
+use Exception;
+use Google\Cloud\ErrorReporting\Bootstrap;
+use Illuminate\Foundation\Exceptions\Handler as ExceptionHandler;
+
+class Handler extends ExceptionHandler
+{
+    /**
+     * A list of the exception types that are not reported.
+     *
+     * @var array
+     */
+    protected $dontReport = [
+        //
+    ];
+
+    /**
+     * A list of the inputs that are never flashed for validation exceptions.
+     *
+     * @var array
+     */
+    protected $dontFlash = [
+        'password',
+        'password_confirmation',
+    ];
+
+    /**
+     * Report or log an exception.
+     *
+     * This is a great spot to send exceptions to Sentry, Bugsnag, etc.
+     *
+     * @param  \Exception  $exception
+     * @return void
+     */
+    # [START error_reporting_setup_php_laravel]
+    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);
+        }
+    }
+    # [END error_reporting_setup_php_laravel]
+
+    /**
+     * Render an exception into an HTTP response.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Exception  $exception
+     * @return \Illuminate\Http\Response
+     */
+    public function render($request, Exception $exception)
+    {
+        return parent::render($request, $exception);
+    }
+}

appengine/php72/laravel-framework/app/Logging/CreateStackdriverLogger.php

@@ -0,0 +1,25 @@
+
+
+namespace App\Logging;
+
+use Google\Cloud\Logging\LoggingClient;
+use Monolog\Handler\PsrHandler;
+use Monolog\Logger;
+
+class CreateStackdriverLogger
+{
+    /**
+     * Create a custom Monolog instance.
+     *
+     * @param  array  $config
+     * @return \Monolog\Logger
+     */
+    public function __invoke(array $config)
+    {
+        $logName = isset($config['logName']) ? $config['logName'] : 'app';
+        $psrLogger = LoggingClient::psrBatchLogger($logName);
+        $handler = new PsrHandler($psrLogger);
+        $logger = new Logger($logName, [$handler]);
+        return $logger;
+    }
+}

appengine/php72/laravel-framework/composer.json

@@ -2,6 +2,7 @@
     "require-dev": {
         "google/cloud-tools": "^0.8.1",
         "symfony\/process": "~2.8|~3.0",
-        "monolog\/monolog": "^1.19"
+        "monolog\/monolog": "^1.19",
+        "google/cloud-logging": "^1.14"
     }
 }

appengine/php72/laravel-framework/config/logging.php

@@ -0,0 +1,77 @@
+
+
+return [
+
+    /*
+    |--------------------------------------------------------------------------
+    | Default Log Channel
+    |--------------------------------------------------------------------------
+    |
+    | This option defines the default log channel that gets used when writing
+    | messages to the logs. The name specified in this option should match
+    | one of the channels defined in the "channels" configuration array.
+    |
+    */
+
+    'default' => env('LOG_CHANNEL', 'stack'),
+
+    /*
+    |--------------------------------------------------------------------------
+    | Log Channels
+    |--------------------------------------------------------------------------
+    |
+    | Here you may configure the log channels for your application. Out of
+    | the box, Laravel uses the Monolog PHP logging library. This gives
+    | you a variety of powerful log handlers / formatters to utilize.
+    |
+    | Available Drivers: "single", "daily", "slack", "syslog",
+    |                    "errorlog", "custom", "stack"
+    |
+    */
+
+    'channels' => [
+        'stack' => [
+            'driver' => 'stack',
+            'channels' => ['single'],
+        ],
+
+        'single' => [
+            'driver' => 'single',
+            'path' => storage_path('logs/laravel.log'),
+            'level' => 'debug',
+        ],
+
+        'daily' => [
+            'driver' => 'daily',
+            'path' => storage_path('logs/laravel.log'),
+            'level' => 'debug',
+            'days' => 7,
+        ],
+
+        'slack' => [
+            'driver' => 'slack',
+            'url' => env('LOG_SLACK_WEBHOOK_URL'),
+            'username' => 'Laravel Log',
+            'emoji' => ':boom:',
+            'level' => 'critical',
+        ],
+
+        'syslog' => [
+            'driver' => 'syslog',
+            'level' => 'debug',
+        ],
+
+        'errorlog' => [
+            'driver' => 'errorlog',
+            'level' => 'debug',
+        ],
+
+        'stackdriver' => [
+            'driver' => 'custom',
+            'via' => App\Logging\CreateStackdriverLogger::class,
+            'level' => 'debug',
+        ],
+
+    ],
+
+];

appengine/php72/laravel-framework/routes/web.php

@@ -0,0 +1,25 @@
+
+
+/*
+|--------------------------------------------------------------------------
+| Web Routes
+|--------------------------------------------------------------------------
+|
+| Here is where you can register web routes for your application. These
+| routes are loaded by the RouteServiceProvider within a group which
+| contains the "web" middleware group. Now create something great!
+|
+*/
+
+Route::get('/', function () {
+    return view('welcome');
+});
+
+Route::get('/log/{token}', function ($token) {
+    Log::info("Hello my log, token: $token");
+    return view('welcome');
+});
+
+Route::get('/exception/{token}', function ($token) {
+    throw new Exception("Intentional exception, token: $token");
+});

appengine/php72/laravel-framework/test/DeployLaravelTrait.php

@@ -37,16 +37,10 @@ private static function createLaravelProject()
         self::executeProcess($process);
 
         // move the code for the sample to the new laravel installation
-        $files = [
-            // '.gcloudignore',
+        self::copyFiles([
             'bootstrap/app.php',
             'config/view.php',
-        ];
-        foreach ($files as $file) {
-            $source = sprintf('%s/../%s', __DIR__, $file);
-            $target = sprintf('%s/%s', $tmpDir, $file);
-            copy($source, $target);
-        }
+        ], $tmpDir);
 
         // set the directory in gcloud and move there
         self::setWorkingDirectory($tmpDir);
@@ -66,4 +60,13 @@ private static function addAppKeyToAppYaml($targetDir)
         ], file_get_contents($targetDir . '/app.yaml'));
         file_put_contents($targetDir . '/app.yaml', $appYaml);
     }
+
+    private static function copyFiles(array $files, $dir)
+    {
+        foreach ($files as $file) {
+            $source = sprintf('%s/../%s', __DIR__, $file);
+            $target = sprintf('%s/%s', $dir, $file);
+            copy($source, $target);
+        }
+    }
 }