vendor/sentry/sentry/src/Monolog/Handler.php line 21

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. namespace Sentry\Monolog;
  7. use Monolog\Handler\AbstractProcessingHandler;
  8. use Monolog\Logger;
  9. use Monolog\LogRecord;
  10. use Sentry\Event;
  11. use Sentry\EventHint;
  12. use Sentry\State\HubInterface;
  13. use Sentry\State\Scope;
  15. /**
  16.  * This Monolog handler logs every message to a Sentry's server using the given
  17.  * hub instance.
  18.  *
  19.  * @author Stefano Arlandini <sarlandini@alice.it>
  20.  */
  21. final class Handler extends AbstractProcessingHandler
  22. {
  23.     use CompatibilityProcessingHandlerTrait;
  25.     private const CONTEXT_EXCEPTION_KEY = 'exception';
  27.     /**
  28.      * @var HubInterface
  29.      */
  30.     private $hub;
  32.     /**
  33.      * @var bool
  34.      */
  35.     private $fillExtraContext;
  37.     /**
  38.      * {@inheritdoc}
  39.      *
  40.      * @param HubInterface $hub The hub to which errors are reported
  41.      */
  42.     public function __construct(HubInterface $hub, $level = Logger::DEBUG, bool $bubble = true, bool $fillExtraContext = false)
  43.     {
  44.         parent::__construct($level, $bubble);
  46.         $this->hub = $hub;
  47.         $this->fillExtraContext = $fillExtraContext;
  48.     }
  50.     /**
  51.      * @param array<string, mixed>|LogRecord $record
  52.      */
  53.     protected function doWrite($record): void
  54.     {
  55.         $event = Event::createEvent();
  56.         $event->setLevel(self::getSeverityFromLevel($record['level']));
  57.         $event->setMessage($record['message']);
  58.         $event->setLogger(sprintf('monolog.%s', $record['channel']));
  60.         $hint = new EventHint();
  62.         if (isset($record['context']['exception']) && $record['context']['exception'] instanceof \Throwable) {
  63.             $hint->exception = $record['context']['exception'];
  64.         }
  66.         $this->hub->withScope(function (Scope $scope) use ($record, $event, $hint): void {
  67.             $scope->setExtra('monolog.channel', $record['channel']);
  68.             $scope->setExtra('monolog.level', $record['level_name']);
  70.             $monologContextData = $this->getMonologContextData($record['context']);
  72.             if ([] !== $monologContextData) {
  73.                 $scope->setExtra('monolog.context', $monologContextData);
  74.             }
  76.             $monologExtraData = $this->getMonologExtraData($record['extra']);
  78.             if ([] !== $monologExtraData) {
  79.                 $scope->setExtra('monolog.extra', $monologExtraData);
  80.             }
  82.             $this->hub->captureEvent($event, $hint);
  83.         });
  84.     }
  86.     /**
  87.      * @param mixed[] $context
  88.      *
  89.      * @return mixed[]
  90.      */
  91.     private function getMonologContextData(array $context): array
  92.     {
  93.         if (!$this->fillExtraContext) {
  94.             return [];
  95.         }
  97.         $contextData = [];
  99.         foreach ($context as $key => $value) {
  100.             // We skip the `exception` field because it goes in its own context
  101.             if (self::CONTEXT_EXCEPTION_KEY === $key) {
  102.                 continue;
  103.             }
  105.             $contextData[$key] = $value;
  106.         }
  108.         return $contextData;
  109.     }
  111.     /**
  112.      * @param mixed[] $context
  113.      *
  114.      * @return mixed[]
  115.      */
  116.     private function getMonologExtraData(array $context): array
  117.     {
  118.         if (!$this->fillExtraContext) {
  119.             return [];
  120.         }
  122.         $extraData = [];
  124.         foreach ($context as $key => $value) {
  125.             $extraData[$key] = $value;
  126.         }
  128.         return $extraData;
  129.     }
  130. }