Add stackdriver to symfony php72 (GoogleCloudPlatform#817)

Author: bshaffer

appengine/php72/laravel-framework/README.md

@@ -133,15 +133,15 @@ Logging and Error Reporting:
 
 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`:
+1. First, create a custom logger in `app/Logging/CreateStackdriverLogger.php`:
     ```php
     namespace App\Logging;
 
     use Google\Cloud\Logging\LoggingClient;
     use Monolog\Handler\PsrHandler;
     use Monolog\Logger;
 
-    class CreateCustomLogger
+    class CreateStackdriverLogger
     {
         /**
          * Create a custom Monolog instance.
@@ -168,7 +168,7 @@ You can write logs to Stackdriver Logging from PHP applications by using the Sta
         // Add the following lines to integrate with Stackdriver:
         'stackdriver' => [
             'driver' => 'custom',
-            'via' => App\Logging\CreateCustomLogger::class,
+            'via' => App\Logging\CreateStackdriverLogger::class,
             'level' => 'debug',
         ],
     ```

appengine/php72/laravel-framework/composer.json

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

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

@@ -57,7 +57,7 @@ public function testHomepage()
         $this->assertContains('Laravel', $resp->getBody()->getContents());
     }
 
-    public function testNormalLog()
+    public function testLogging()
     {
         // bump up the retry count because logs can take a bit to show up
         $this->eventuallyConsistentRetryCount = 5;
@@ -92,7 +92,7 @@ public function testNormalLog()
         });
     }
 
-    public function testErrorLog()
+    public function testErrorReporting()
     {
         $this->eventuallyConsistentRetryCount = 5;
         $logging = new LoggingClient([

appengine/php72/symfony-framework/README.md

@@ -9,10 +9,10 @@ to App Engine Standard for PHP 7.2. You will learn how to:
 1. Set up a [Cloud SQL][cloud-sql] database
 1. Configure Doctrine to communicate with Cloud SQL
 
-> **Note**: This repository is just a tutorial and is not a Symfony project in 
+> **Note**: This repository is just a tutorial and is not a Symfony project in
   and of itself. The steps will require you to set up a new Symfony project in a
   separate directory.
-  
+
 ## Prerequisites
 
 1. [Create a project][create-project] in the Google Cloud Platform Console
@@ -205,12 +205,66 @@ database. This tutorial uses the database name `symfonydb` and the username
 
         gcloud app deploy
 
-### What's Next
+## Set up Stackdriver Logging and Error Reporting
+
+Install the Google Cloud libraries for Stackdriver integration:
+
+```sh
+# Set the environment variable below to the local path to your symfony project
+SYMFONY_PROJECT_PATH="/path/to/my-symfony-project"
+cd $SYMFONY_PROJECT_PATH
+composer require google/cloud-logging google/cloud-error-reporting
+```
+
+### Copy over App Engine files
+
+For your Symfony application to integrate with Stackdriver Logging and Error Handling,
+you will need to copy over the `monolog.yaml` config file and the `ExceptionSubscriber.php`
+Exception Subscriber:
+
+```sh
+# clone the Google Cloud Platform PHP samples repo somewhere
+cd /path/to/php-samples
+git clone https://github.com/GoogleCloudPlatform/php-docs-samples
+
+# enter the directory for the symfony framework sample
+cd appengine/php72/symfony-framework/
+
+# copy monolog.yaml into your Symfony project
+cp config/packages/prod/monolog.yaml \
+    $SYMFONY_PROJECT_PATH/config/packages/prod/
+
+# copy ExceptionSubscriber.php into your Symfony project
+cp src/EventSubscriber/ExceptionSubscriber.php \
+    $SYMFONY_PROJECT_PATH/src/EventSubscriber
+```
+
+The two files needed are as follows:
+
+  1. [`config/packages/prod/monolog.yaml`](app/config/packages/prod/monolog.yaml) - Adds Stackdriver Logging to your Monolog configuration.
+  1. [`src/EventSubscriber/ExceptionSubscriber.php`](src/EventSubscriber/ExceptionSubscriber.php) - Event subscriber which sends exceptions to Stackdriver Error Reporting.
+
+If you'd like to test the logging and error reporting, you can also copy over `LoggingController.php`, which
+exposes the routes `/en/logging/notice` and `/en/logging/exception` for ensuring your logs are being sent to
+Stackdriver:
+
+```
+# copy LoggingController.php into your Symfony project
+cp src/Controller/LoggingController.php \
+    $SYMFONY_PROJECT_PATH/src/Controller
+```
+
+  1. [`src/Controller/LoggingController.php`](src/Controller/LoggingController.php) - Controller for testing logging and exceptions.
+
+### View application logs and errors
 
-1. Check out the [Databases and the Doctrine ORM][symfony-doctrine] documentation for Symfony.
-1. View a [Symfony Demo Application][symfony-sample-app] for App Engine Flex.
+Once you've redeployed your application using `gcloud app deploy`, you'll be able to view
+Application logs in the [Stackdriver Logging UI][stackdriver-logging-ui], and errors in
+the [Stackdriver Error Reporting UI][stackdriver-errorreporting-ui]! If you copied over the
+`LoggingController.php` file, you can test this by pointing your browser to
+`https://YOUR_PROJECT_ID.appspot.com/en/logging/notice` and
+`https://YOUR_PROJECT_ID.appspot.com/en/logging/exception`
 
-[php-gcp]: https://cloud.google.com/php
 [cloud-sdk]: https://cloud.google.com/sdk/
 [cloud-build]: https://cloud.google.com/cloud-build/
 [cloud-sql]: https://cloud.google.com/sql/docs/
@@ -219,14 +273,12 @@ database. This tutorial uses the database name `symfonydb` and the username
 [cloud-sql-apis]:https://pantheon.corp.google.com/apis/library/sqladmin.googleapis.com/?pro
 [create-project]: https://cloud.google.com/resource-manager/docs/creating-managing-projects
 [enable-billing]: https://support.google.com/cloud/answer/6293499?hl=en
-[php-gcp]: https://cloud.google.com/php
 [symfony]: http://symfony.com
 [symfony-install]: http://symfony.com/doc/current/setup.html
 [symfony-welcome]: https://symfony.com/doc/current/_images/welcome.png
-[composer-json]: https://storage.googleapis.com/gcp-community/tutorials/run-symfony-on-appengine-flexible/composer-json.png
-[symfony-doctrine]: https://symfony.com/doc/current/doctrine.html
-[symfony-sample-app]: https://github.com/bshaffer/symfony-on-app-engine-flex
 [symfony-demo]: https://github.com/symfony/demo
 [symfony-secret]: http://symfony.com/doc/current/reference/configuration/framework.html#secret
 [symfony-env]: https://symfony.com/doc/current/configuration/environments.html#executing-an-application-in-different-environments
 [symfony-override-cache]: https://symfony.com/doc/current/configuration/override_dir_structure.html#override-the-cache-directory
+[stackdriver-logging-ui]: https://console.cloud.google.com/logs
+[stackdriver-errorreporting-ui]: https://console.cloud.google.com/errors

appengine/php72/symfony-framework/composer.json

@@ -5,6 +5,7 @@
     "require-dev": {
         "google/cloud-tools": "^0.8.2",
         "monolog/monolog": "^1.19",
-        "nikic/php-parser": "^4.0"
+        "nikic/php-parser": "^4.0",
+        "google/cloud-logging": "^1.14"
     }
 }

appengine/php72/symfony-framework/config/packages/prod/monolog.yaml

@@ -0,0 +1,40 @@
+monolog:
+    handlers:
+        main:
+            type: fingers_crossed
+            action_level: error
+            handler: nested
+            excluded_http_codes: [404]
+        nested:
+            type: stream
+            path: "%kernel.logs_dir%/%kernel.environment%.log"
+            level: debug
+        console:
+            type: console
+            process_psr_3_messages: false
+            channels: ["!event", "!doctrine"]
+        deprecation:
+            type: stream
+            path: "%kernel.logs_dir%/%kernel.environment%.deprecations.log"
+        deprecation_filter:
+            type: filter
+            handler: deprecation
+            max_level: info
+            channels: ["php"]
+        # [START add_stackdriver_to_symfony_monolog]
+        google_cloud:
+            type: service
+            id: monolog_psr_batch_logger
+
+services:
+    # Monolog wrapper
+    monolog_psr_batch_logger:
+        class: Monolog\Handler\PsrHandler
+        arguments: ['@google_cloud_stackdriver_psr_batch_logger']
+
+    # PsrBatchLogger
+    google_cloud_stackdriver_psr_batch_logger:
+        class: Google\Cloud\Logging\PsrLogger
+        factory: ['Google\Cloud\Logging\LoggingClient', 'psrBatchLogger']
+        arguments: ['app']
+# [END add_stackdriver_to_symfony_monolog]

appengine/php72/symfony-framework/phpunit.xml.dist

@@ -14,9 +14,9 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 -->
-<phpunit bootstrap="vendor/autoload.php">
+<phpunit bootstrap="test/bootstrap.php">
     <testsuites>
-        <testsuite name="AppEngine for PHP  7.2 Symfony Framework tests">
+        <testsuite name="AppEngine for PHP 7.2 Symfony Framework tests">
             <directory>testdirectory>
         testsuite>
     testsuites>

appengine/php72/symfony-framework/src/Controller/LoggingController.php

@@ -0,0 +1,53 @@
+
+
+/**
+ * Copyright 2019 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace App\Controller;
+
+use Psr\Log\LoggerInterface;
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
+use Exception;
+
+/**
+ * Controller used to test Stackdriver Logging integration on Google Cloud Platform
+ *
+ * @Route("/logging")
+ *
+ * @author Brent Shaffer 
+ */
+class LoggingController extends AbstractController
+{
+    /**
+     * @Route("/notice/{token}", defaults={"token"=0}, methods={"GET"})
+     */
+    public function notice(LoggerInterface $logger, $token): Response
+    {
+        $logger->notice("Hello my log, token: $token");
+
+        return $this->render('default/homepage.html.twig');
+    }
+
+    /**
+     * @Route("/exception/{token}", defaults={"token"=0}, methods={"GET"})
+     */
+    public function exception($token): Response
+    {
+        throw new Exception("Intentional exception, token: $token");
+    }
+}

appengine/php72/symfony-framework/src/EventSubscriber/ExceptionSubscriber.php

@@ -0,0 +1,50 @@
+
+
+/**
+ * Copyright 2019 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+# [START error_reporting_setup_php_symfony]
+// src/EventSubscriber/ExceptionSubscriber.php
+namespace App\EventSubscriber;
+
+use Google\Cloud\ErrorReporting\Bootstrap;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\GetResponseForExceptionEvent;
+use Symfony\Component\HttpKernel\KernelEvents;
+
+/**
+ * EventSubscrber used to log all exceptions to Stackdriver Error Reporting on Google Cloud Platform
+ *
+ * @author Brent Shaffer 
+ */
+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::init();
+        Bootstrap::exceptionHandler($exception);
+    }
+}
+# [END error_reporting_setup_php_symfony]

appengine/php72/symfony-framework/test/DeployDoctrineTest.php

@@ -20,15 +20,16 @@
 use Google\Cloud\TestUtils\TestTrait;
 use PHPUnit\Framework\TestCase;
 
-require_once __DIR__ . '/lib/SymfonyDeploymentTrait.php';
-
 class DeployDoctrineTest extends TestCase
 {
     use TestTrait;
-    use SymfonyDeploymentTrait;
+    use DeploySymfonyTrait;
 
     public static function beforeDeploy()
     {
+        // ensure logging output is displayed in phpunit
+        self::$logger = new \Monolog\Logger('phpunit');
+
         $dbConn = self::requireEnv('SYMFONY_CLOUDSQL_CONNECTION_NAME');
         $dbName = self::requireEnv('SYMFONY_DB_DATABASE');
         $dbPass = self::requireEnv('SYMFONY_DB_PASSWORD');

appengine/php72/symfony-framework/test/lib/SymfonyDeploymentTrait.php renamed to appengine/php72/symfony-framework/test/DeploySymfonyTrait.php

@@ -26,22 +26,12 @@
 use PhpParser\Node\Stmt\ClassMethod;
 use PhpParser\NodeTraverser;
 use PhpParser\NodeVisitorAbstract;
-use Monolog\Logger;
 
-trait SymfonyDeploymentTrait
+trait DeploySymfonyTrait
 {
     use AppEngineDeploymentTrait;
     use ExecuteCommandTrait;
 
-    /**
-     * @beforeClass
-     */
-    public static function setMonologLogger()
-    {
-        // ensure logging output is displayed in phpunit
-        self::$logger = new Logger('phpunit');
-    }
-
     private static function createSymfonyProject()
     {
         $tmpDir = sys_get_temp_dir() . '/test-' . FileUtil::randomName(8);
@@ -56,7 +46,7 @@ private static function createSymfonyProject()
         self::executeProcess($process);
 
         // move app.yaml for the sample to the new symfony installation
-        copy(__DIR__ . '/../../app.yaml', $tmpDir . '/app.yaml');
+        self::copyFiles(['app.yaml'], $tmpDir);
 
         // Remove the scripts from composer so they do not error out in the
         // Cloud Build environment.
@@ -104,4 +94,13 @@ public function enterNode(Node $node)
         $prettyPrinter = new PrettyPrinter\Standard();
         file_put_contents($kernelFile, $prettyPrinter->prettyPrintFile($ast));
     }
+
+    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);
+        }
+    }
 }