src/EventsSubscriber/System/RequestLogSubscriber.php line 50

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace App\EventsSubscriber\System;
  7. use Psr\Log\LoggerInterface;
  8. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  9. use Symfony\Component\HttpFoundation\Request;
  10. use Symfony\Component\HttpKernel\Event\RequestEvent;
  11. use Symfony\Component\HttpKernel\Event\ResponseEvent;
  12. use Symfony\Component\HttpKernel\KernelEvents;
  14. /**
  15.  * Structured access log for every API request, shipped to CloudWatch via the "request" channel.
  16.  *
  17.  * Metadata (method, path, status, creator, client IP, latency) is logged for ALL requests. The
  18.  * request BODY is logged only for an explicit allow-list of endpoints whose payload carries no
  19.  * credentials (e.g. geolocation coordinates). Auth/payment bodies are never logged, and a key
  20.  * redactor is applied to anything that is logged as a backstop.
  21.  */
  22. final class RequestLogSubscriber implements EventSubscriberInterface
  23. {
  24.     private const START_ATTR = '_request_log_start';
  26.     /** Endpoints whose JSON body is safe to log in full (no credentials). */
  27.     private const BODY_ALLOWLIST = [
  28.         '#^/api/v\d+/creators/\d+/geolocation#',
  29.     ];
  31.     /** Body keys whose value is replaced with "[redacted]" (compared case/format-insensitively). */
  32.     private const REDACT_KEYS = [
  33.         'password', 'token', 'accesstoken', 'refreshtoken', 'secret', 'authorization',
  34.         'apikey', 'card', 'cardnumber', 'cvv', 'cvc', 'pan', 'pin',
  35.     ];
  37.     public function __construct(
  38.         private readonly LoggerInterface $requestLogger,
  39.     ) {
  40.     }
  42.     public static function getSubscribedEvents(): array
  43.     {
  44.         return [
  45.             KernelEvents::REQUEST => ['onRequest', 1024],
  46.             KernelEvents::RESPONSE => ['onResponse', -300],
  47.         ];
  48.     }
  50.     public function onRequest(RequestEvent $event): void
  51.     {
  52.         if (!$event->isMainRequest()) {
  53.             return;
  54.         }
  56.         $event->getRequest()->attributes->set(self::START_ATTR, microtime(true));
  57.     }
  59.     public function onResponse(ResponseEvent $event): void
  60.     {
  61.         if (!$event->isMainRequest()) {
  62.             return;
  63.         }
  65.         $request = $event->getRequest();
  66.         $start = $request->attributes->get(self::START_ATTR);
  68.         $context = [
  69.             'method' => $request->getMethod(),
  70.             'path' => $request->getPathInfo(),
  71.             'route' => $request->attributes->get('_route'),
  72.             'status' => $event->getResponse()->getStatusCode(),
  73.             'creator_id' => $this->resolveUserId($request),
  74.             'client_ip' => $request->getClientIp(),
  75.             'duration_ms' => is_float($start) ? (int) round((microtime(true) - $start) * 1000) : null,
  76.             'request_id' => $request->headers->get('X-Amzn-Trace-Id') ?? $request->headers->get('X-Request-Id'),
  77.             'user_agent' => $request->headers->get('User-Agent'),
  78.         ];
  80.         $body = $this->loggableBody($request);
  81.         if ($body !== null) {
  82.             $context['body'] = $body;
  83.         }
  85.         $this->requestLogger->info('api_request', $context);
  86.     }
  88.     private function resolveUserId(Request $request): ?int
  89.     {
  90.         if (preg_match('#/(?:creators|sponsors)/(\d+)#', $request->getPathInfo(), $matches) === 1) {
  91.             return (int) $matches[1];
  92.         }
  94.         return null;
  95.     }
  97.     /**
  98.      * @return array<array-key, mixed>|null
  99.      */
  100.     private function loggableBody(Request $request): ?array
  101.     {
  102.         if (!in_array($request->getMethod(), [Request::METHOD_POST, Request::METHOD_PUT, Request::METHOD_PATCH], true)) {
  103.             return null;
  104.         }
  106.         $path = $request->getPathInfo();
  107.         $allowed = false;
  108.         foreach (self::BODY_ALLOWLIST as $pattern) {
  109.             if (preg_match($pattern, $path) === 1) {
  110.                 $allowed = true;
  111.                 break;
  112.             }
  113.         }
  114.         if (!$allowed) {
  115.             return null;
  116.         }
  118.         $raw = $request->getContent();
  119.         if ($raw === '') {
  120.             return null;
  121.         }
  123.         try {
  124.             $decoded = json_decode($raw, true, 512, JSON_THROW_ON_ERROR);
  125.         } catch (\JsonException) {
  126.             return null;
  127.         }
  129.         return is_array($decoded) ? $this->redact($decoded) : null;
  130.     }
  132.     /**
  133.      * @param array<array-key, mixed> $data
  134.      *
  135.      * @return array<array-key, mixed>
  136.      */
  137.     private function redact(array $data): array
  138.     {
  139.         foreach ($data as $key => $value) {
  140.             if (is_array($value)) {
  141.                 $data[$key] = $this->redact($value);
  142.                 continue;
  143.             }
  145.             if (is_string($key) && in_array($this->normalizeKey($key), self::REDACT_KEYS, true)) {
  146.                 $data[$key] = '[redacted]';
  147.             }
  148.         }
  150.         return $data;
  151.     }
  153.     private function normalizeKey(string $key): string
  154.     {
  155.         return preg_replace('/[^a-z0-9]/', '', strtolower($key)) ?? '';
  156.     }
  157. }