vendor/zenstruck/schedule-bundle/src/EventListener/ScheduleLoggerSubscriber.php line 114

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the zenstruck/schedule-bundle package.
  5.  *
  6.  * (c) Kevin Bond <kevinbond@gmail.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Zenstruck\ScheduleBundle\EventListener;
  14. use Psr\Log\LoggerInterface;
  15. use Psr\Log\LogLevel;
  16. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  17. use Zenstruck\ScheduleBundle\Event\AfterScheduleEvent;
  18. use Zenstruck\ScheduleBundle\Event\AfterTaskEvent;
  19. use Zenstruck\ScheduleBundle\Event\BeforeScheduleEvent;
  20. use Zenstruck\ScheduleBundle\Event\BeforeTaskEvent;
  22. /**
  23.  * @author Kevin Bond <kevinbond@gmail.com>
  24.  */
  25. final class ScheduleLoggerSubscriber implements EventSubscriberInterface
  26. {
  27.     /** @var LoggerInterface */
  28.     private $logger;
  30.     public function __construct(LoggerInterface $logger)
  31.     {
  32.         $this->logger = $logger;
  33.     }
  35.     public static function getSubscribedEvents(): array
  36.     {
  37.         return [
  38.             BeforeScheduleEvent::class => 'beforeSchedule',
  39.             AfterScheduleEvent::class => 'afterSchedule',
  40.             BeforeTaskEvent::class => 'beforeTask',
  41.             AfterTaskEvent::class => 'afterTask',
  42.         ];
  43.     }
  45.     public function beforeSchedule(BeforeScheduleEvent $event): void
  46.     {
  47.         $context = $event->runContext();
  49.         $allTaskCount = \count($context->getSchedule()->all());
  50.         $dueTaskCount = \count($context->dueTasks());
  52.         if (0 === $dueTaskCount) {
  53.             $this->logger->debug('No tasks due to run.', ['total' => $allTaskCount]);
  55.             return;
  56.         }
  58.         $message = \sprintf('%s %d %stask%s.',
  59.             $context->isForceRun() ? 'Force running' : 'Running',
  60.             $dueTaskCount,
  61.             $context->isForceRun() ? '' : 'due ',
  62.             $dueTaskCount > 1 ? 's' : ''
  63.         );
  65.         $this->logger->info($message, [
  66.             'total' => $allTaskCount,
  67.             'due' => $dueTaskCount,
  68.         ]);
  69.     }
  71.     public function afterSchedule(AfterScheduleEvent $event): void
  72.     {
  73.         $context = $event->runContext();
  75.         if ($context->isSkipped()) {
  76.             $this->logger->info($context->getSkipReason());
  78.             return;
  79.         }
  81.         $total = \count($context->getResults());
  82.         $successful = \count($context->getSuccessful());
  83.         $failures = \count($context->getFailures());
  84.         $skipped = \count($context->getSkipped());
  85.         $run = \count($context->getRun());
  86.         $level = $context->isSuccessful() ? LogLevel::INFO : LogLevel::ERROR;
  88.         if (0 === $total) {
  89.             return;
  90.         }
  92.         $this->logger->log($level, "{$run}/{$total} tasks ran", [
  93.             'total' => $total,
  94.             'successful' => $successful,
  95.             'skipped' => $skipped,
  96.             'failures' => $failures,
  97.             'duration' => $context->getFormattedDuration(),
  98.             'memory' => $context->getFormattedMemory(),
  99.             'forced' => $context->isForceRun(),
  100.         ]);
  101.     }
  103.     public function beforeTask(BeforeTaskEvent $event): void
  104.     {
  105.         $context = $event->runContext();
  106.         $task = $context->getTask();
  108.         $this->logger->info(\sprintf('%s "%s"',
  109.             $context->getScheduleRunContext()->isForceRun() ? 'Force running' : 'Running',
  110.             $task
  111.         ), ['id' => $task->getId()]);
  112.     }
  114.     public function afterTask(AfterTaskEvent $event): void
  115.     {
  116.         $context = $event->runContext();
  118.         $result = $context->getResult();
  119.         $task = $result->getTask();
  120.         $logContext = ['id' => $task->getId()];
  122.         if ($result->isSkipped()) {
  123.             $this->logger->info("Skipped \"{$task}\" ({$result->getDescription()})", $logContext);
  125.             return;
  126.         }
  128.         $logContext['result'] = $result->getDescription();
  129.         $logContext['duration'] = $context->getFormattedDuration();
  130.         $logContext['memory'] = $context->getFormattedMemory();
  131.         $logContext['forced'] = $context->getScheduleRunContext()->isForceRun();
  133.         if ($result->isSuccessful()) {
  134.             $this->logger->info("Successfully ran \"{$task}\"", $logContext);
  136.             return;
  137.         }
  139.         if ($result->getOutput()) {
  140.             $logContext['output'] = $result->getOutput();
  141.         }
  143.         if (!$result->isException()) {
  144.             $this->logger->error("Failure when running \"{$task}\"", $logContext);
  146.             return;
  147.         }
  149.         $logContext['exception'] = $result->getException();
  151.         $this->logger->critical("Exception thrown when running \"{$task}\"", $logContext);
  152.     }
  153. }