RollbarHandler.php 3.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132
  1. <?php
  2. /*
  3. * This file is part of the Monolog package.
  4. *
  5. * (c) Jordi Boggiano <j.boggiano@seld.be>
  6. *
  7. * For the full copyright and license information, please view the LICENSE
  8. * file that was distributed with this source code.
  9. */
  10. namespace Monolog\Handler;
  11. use RollbarNotifier;
  12. use Exception;
  13. use Monolog\Logger;
  14. /**
  15. * Sends errors to Rollbar
  16. *
  17. * If the context data contains a `payload` key, that is used as an array
  18. * of payload options to RollbarNotifier's report_message/report_exception methods.
  19. *
  20. * Rollbar's context info will contain the context + extra keys from the log record
  21. * merged, and then on top of that a few keys:
  22. *
  23. * - level (rollbar level name)
  24. * - monolog_level (monolog level name, raw level, as rollbar only has 5 but monolog 8)
  25. * - channel
  26. * - datetime (unix timestamp)
  27. *
  28. * @author Paul Statezny <paulstatezny@gmail.com>
  29. */
  30. class RollbarHandler extends AbstractProcessingHandler
  31. {
  32. /**
  33. * Rollbar notifier
  34. *
  35. * @var RollbarNotifier
  36. */
  37. protected $rollbarNotifier;
  38. protected $levelMap = array(
  39. Logger::DEBUG => 'debug',
  40. Logger::INFO => 'info',
  41. Logger::NOTICE => 'info',
  42. Logger::WARNING => 'warning',
  43. Logger::ERROR => 'error',
  44. Logger::CRITICAL => 'critical',
  45. Logger::ALERT => 'critical',
  46. Logger::EMERGENCY => 'critical',
  47. );
  48. /**
  49. * Records whether any log records have been added since the last flush of the rollbar notifier
  50. *
  51. * @var bool
  52. */
  53. private $hasRecords = false;
  54. protected $initialized = false;
  55. /**
  56. * @param RollbarNotifier $rollbarNotifier RollbarNotifier object constructed with valid token
  57. * @param int $level The minimum logging level at which this handler will be triggered
  58. * @param bool $bubble Whether the messages that are handled can bubble up the stack or not
  59. */
  60. public function __construct(RollbarNotifier $rollbarNotifier, $level = Logger::ERROR, $bubble = true)
  61. {
  62. $this->rollbarNotifier = $rollbarNotifier;
  63. parent::__construct($level, $bubble);
  64. }
  65. /**
  66. * {@inheritdoc}
  67. */
  68. protected function write(array $record)
  69. {
  70. if (!$this->initialized) {
  71. // __destructor() doesn't get called on Fatal errors
  72. register_shutdown_function(array($this, 'close'));
  73. $this->initialized = true;
  74. }
  75. $context = $record['context'];
  76. $payload = array();
  77. if (isset($context['payload'])) {
  78. $payload = $context['payload'];
  79. unset($context['payload']);
  80. }
  81. $context = array_merge($context, $record['extra'], array(
  82. 'level' => $this->levelMap[$record['level']],
  83. 'monolog_level' => $record['level_name'],
  84. 'channel' => $record['channel'],
  85. 'datetime' => $record['datetime']->format('U'),
  86. ));
  87. if (isset($context['exception']) && $context['exception'] instanceof Exception) {
  88. $payload['level'] = $context['level'];
  89. $exception = $context['exception'];
  90. unset($context['exception']);
  91. $this->rollbarNotifier->report_exception($exception, $context, $payload);
  92. } else {
  93. $this->rollbarNotifier->report_message(
  94. $record['message'],
  95. $context['level'],
  96. $context,
  97. $payload
  98. );
  99. }
  100. $this->hasRecords = true;
  101. }
  102. public function flush()
  103. {
  104. if ($this->hasRecords) {
  105. $this->rollbarNotifier->flush();
  106. $this->hasRecords = false;
  107. }
  108. }
  109. /**
  110. * {@inheritdoc}
  111. */
  112. public function close()
  113. {
  114. $this->flush();
  115. }
  116. }