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

Open in your IDE?
  1. <?php
  3. namespace Zenstruck\ScheduleBundle\EventListener;
  5. use Psr\Log\LoggerInterface;
  6. use Psr\Log\LogLevel;
  7. use Symfony\Component\EventDispatcher\EventSubscriberInterface;
  8. use Zenstruck\ScheduleBundle\Event\AfterScheduleEvent;
  9. use Zenstruck\ScheduleBundle\Event\AfterTaskEvent;
  10. use Zenstruck\ScheduleBundle\Event\BeforeScheduleEvent;
  11. use Zenstruck\ScheduleBundle\Event\BeforeTaskEvent;
  13. /**
  14.  * @author Kevin Bond <kevinbond@gmail.com>
  15.  */
  16. final class ScheduleLoggerSubscriber implements EventSubscriberInterface
  17. {
  18.     /** @var LoggerInterface */
  19.     private $logger;
  21.     public function __construct(LoggerInterface $logger)
  22.     {
  23.         $this->logger = $logger;
  24.     }
  26.     public static function getSubscribedEvents(): array
  27.     {
  28.         return [
  29.             BeforeScheduleEvent::class => 'beforeSchedule',
  30.             AfterScheduleEvent::class => 'afterSchedule',
  31.             BeforeTaskEvent::class => 'beforeTask',
  32.             AfterTaskEvent::class => 'afterTask',
  33.         ];
  34.     }
  36.     public function beforeSchedule(BeforeScheduleEvent $event): void
  37.     {
  38.         $context = $event->runContext();
  40.         $allTaskCount = \count($context->getSchedule()->all());
  41.         $dueTaskCount = \count($context->dueTasks());
  43.         if (0 === $dueTaskCount) {
  44.             $this->logger->debug('No tasks due to run.', ['total' => $allTaskCount]);
  46.             return;
  47.         }
  49.         $message = \sprintf('%s %d %stask%s.',
  50.             $context->isForceRun() ? 'Force running' : 'Running',
  51.             $dueTaskCount,
  52.             $context->isForceRun() ? '' : 'due ',
  53.             $dueTaskCount > 1 ? 's' : ''
  54.         );
  56.         $this->logger->info($message, [
  57.             'total' => $allTaskCount,
  58.             'due' => $dueTaskCount,
  59.         ]);
  60.     }
  62.     public function afterSchedule(AfterScheduleEvent $event): void
  63.     {
  64.         $context = $event->runContext();
  66.         if ($context->isSkipped()) {
  67.             $this->logger->info($context->getSkipReason());
  69.             return;
  70.         }
  72.         $total = \count($context->getResults());
  73.         $successful = \count($context->getSuccessful());
  74.         $failures = \count($context->getFailures());
  75.         $skipped = \count($context->getSkipped());
  76.         $run = \count($context->getRun());
  77.         $level = $context->isSuccessful() ? LogLevel::INFO : LogLevel::ERROR;
  79.         if (0 === $total) {
  80.             return;
  81.         }
  83.         $this->logger->log($level, "{$run}/{$total} tasks ran", [
  84.             'total' => $total,
  85.             'successful' => $successful,
  86.             'skipped' => $skipped,
  87.             'failures' => $failures,
  88.             'duration' => $context->getFormattedDuration(),
  89.             'memory' => $context->getFormattedMemory(),
  90.             'forced' => $context->isForceRun(),
  91.         ]);
  92.     }
  94.     public function beforeTask(BeforeTaskEvent $event): void
  95.     {
  96.         $context = $event->runContext();
  97.         $task = $context->getTask();
  99.         $this->logger->info(\sprintf('%s "%s"',
  100.             $context->getScheduleRunContext()->isForceRun() ? 'Force running' : 'Running',
  101.             $task
  102.         ), ['id' => $task->getId()]);
  103.     }
  105.     public function afterTask(AfterTaskEvent $event): void
  106.     {
  107.         $context = $event->runContext();
  109.         $result = $context->getResult();
  110.         $task = $result->getTask();
  111.         $logContext = ['id' => $task->getId()];
  113.         if ($result->isSkipped()) {
  114.             $this->logger->info("Skipped \"{$task}\" ({$result->getDescription()})", $logContext);
  116.             return;
  117.         }
  119.         $logContext['result'] = $result->getDescription();
  120.         $logContext['duration'] = $context->getFormattedDuration();
  121.         $logContext['memory'] = $context->getFormattedMemory();
  122.         $logContext['forced'] = $context->getScheduleRunContext()->isForceRun();
  124.         if ($result->isSuccessful()) {
  125.             $this->logger->info("Successfully ran \"{$task}\"", $logContext);
  127.             return;
  128.         }
  130.         if ($result->getOutput()) {
  131.             $logContext['output'] = $result->getOutput();
  132.         }
  134.         if (!$result->isException()) {
  135.             $this->logger->error("Failure when running \"{$task}\"", $logContext);
  137.             return;
  138.         }
  140.         $logContext['exception'] = $result->getException();
  142.         $this->logger->critical("Exception thrown when running \"{$task}\"", $logContext);
  143.     }
  144. }