Merge pull request #8 from uniplaces/NI/Improve-request-logger-events

[RFC][NI] Update Request logger and minor fixes
uniplaces · May 3, 2018 · c9dddec · c9dddec
2 parents e7fb9a9 + aa7b82d
commit c9dddec
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 2,125 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
 /.idea
 /vendor
 /phpunit.xml
+composer.lock
diff --git a/EventListener/RequestLoggerEventListener.php b/EventListener/RequestLoggerEventListener.php
@@ -3,9 +3,8 @@
 namespace Uniplaces\RequestLoggerBundle\EventListener;
 
 use Psr\Log\LoggerInterface;
-use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpKernel\Event\GetResponseEvent;
-use Symfony\Component\HttpKernel\Event\PostResponseEvent;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
 
 /**
  * RequestLoggerEventListener
@@ -17,11 +16,6 @@ final class RequestLoggerEventListener
      */
     private $logger;
 
-    /**
-     * @var int
-     */
-    private $requestStartTime;
-
     /**
      * @param LoggerInterface $logger
      */
@@ -31,47 +25,31 @@ public function __construct(LoggerInterface $logger)
     }
 
     /**
-     * @param GetResponseEvent $event
-     */
-    public function onRequest(GetResponseEvent $event): void
-    {
-        if (!$event->isMasterRequest()) {
-            return;
-        }
-
-        $this->requestStartTime = microtime(true);
-    }
-
-    /**
-     * @param PostResponseEvent $event
+     * @param FilterResponseEvent $event
      */
-    public function onTerminate(PostResponseEvent $event): void
+    public function onResponse(FilterResponseEvent $event): void
     {
-        $latency = (int)((microtime(true) - $this->requestStartTime) * 1000);
-
         $request = $event->getRequest();
-        $method = $request->getMethod();
         $path = $request->getBasePath();
         $contentType = $request->getContentType();
         $clientIp = $request->getClientIp();
         $userAgent = $request->headers->get('User-Agent');
 
         $response = $event->getResponse();
         $statusCode = $response->getStatusCode();
+        $message = \sprintf(
+            'Response %s for "%s %s"',
+            [$statusCode, $request->getMethod(), $request->getRequestUri()]
+        );
 
-        $queryString = $request->getQueryString();
-        $httpVersion = $request->getProtocolVersion();
-        $responseSize = (int)$response->headers->get('Content-Length');
-        $message = "{$clientIp} \"{$method} {$path}/{$queryString} {$httpVersion} {$statusCode} {$responseSize}\"";
-
-        $this->logRequest(
-            $statusCode,
+        $this->logResponse(
             $message,
             [
-                'method' => $method,
+                'method' => $request->getMethod(),
                 'path' => $path,
+                'uri' => $request->getRequestUri(),
                 'content-type' => $contentType,
-                'latency' => $latency,
+                'latency' => $this->getTime($request),
                 'client-ip' => $clientIp,
                 'status_code' => $statusCode,
                 'user-agent' => $userAgent
@@ -80,24 +58,31 @@ public function onTerminate(PostResponseEvent $event): void
     }
 
     /**
-     * @param int    $statusCode
-     * @param string $message
-     * @param array  $fields
+     * @param Request $request
+     *
+     * @return float|null
      */
-    private function logRequest(int $statusCode, string $message, array $fields): void
+    public function getTime(Request $request): ?float
     {
-        if ($statusCode < Response::HTTP_BAD_REQUEST) {
-            $this->logger->info($message, $fields);
-
-            return;
+        if (!$request->server) {
+            return null;
         }
 
-        if ($statusCode < Response::HTTP_INTERNAL_SERVER_ERROR) {
-            $this->logger->warning($message, $fields);
+        $startTime = $request->server->get(
+            'REQUEST_TIME_FLOAT',
+            $request->server->get('REQUEST_TIME')
+        );
+        $time = microtime(true) - $startTime;
 
-            return;
-        }
+        return round($time * 1000);
+    }
 
-        $this->logger->error($message, $fields);
+    /**
+     * @param string $message
+     * @param array  $fields
+     */
+    private function logResponse(string $message, array $fields): void
+    {
+        $this->logger->info($message, $fields);
     }
 }
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Uniplaces Request Logger Bundle
+# Request Logger Bundle
 
 [![StyleCI](https://styleci.io/repos/129761376/shield?branch=master)](https://styleci.io/repos/129761376)
 

diff --git a/Resources/config/services.yml b/Resources/config/services.yml
@@ -1,13 +1,12 @@
 services:
-    request_logger_bundle.request_logger:
-        class: Uniplaces\RequestLoggerBundle\EventListener\RequestLoggerEventListener
-        arguments: ["@logger"]
+    _defaults:
+        autowire: true
+        public: false
+        autoconfigure: true
+
+    Uniplaces\RequestLoggerBundle\EventListener\RequestLoggerEventListener:
         tags:
             -
                 name: kernel.event_listener
-                event: kernel.request
-                method: onRequest
-            -
-                name: kernel.event_listener
-                event: kernel.terminate
-                method: onTerminate
+                event: kernel.response
+                method: onResponse
diff --git a/composer.json b/composer.json
@@ -3,6 +3,7 @@
     "description": "Symfony bundle to log information about the request like method, uri, latency",
     "type": "bundle",
     "require": {
+        "php": "^7.1.0",
         "symfony/http-kernel": "^4.0",
         "psr/log": "^1.0",
         "symfony/config": "^4.0",