ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
Monolog\Handler\RollbarHandler Class Reference

Sends errors to Rollbar. More...

+ Inheritance diagram for Monolog\Handler\RollbarHandler:
+ Collaboration diagram for Monolog\Handler\RollbarHandler:

Public Member Functions

 __construct (RollbarNotifier $rollbarNotifier, $level=Logger::ERROR, $bubble=true)
 
 flush ()
 
 close ()
 {} More...
 
 reset ()
 {} More...
 
- Public Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
 handle (array $record)
 {Handles a record.All records may be passed to this method, and the handler should discard those that it does not want to handle.The return value of this function controls the bubbling process of the handler stack. Unless the bubbling is interrupted (by returning true), the Logger class will keep on calling further handlers in the stack with a given log record.
Parameters
array$recordThe record to handle
Returns
bool true means that this handler handled the record, and that bubbling is not permitted. false means the record was either not processed or that this handler allows bubbling.
} More...
 
- Public Member Functions inherited from Monolog\Handler\AbstractHandler
 __construct ($level=Logger::DEBUG, $bubble=true)
 
 isHandling (array $record)
 {Checks whether the given record will be handled by this handler.This is mostly done for performance reasons, to avoid calling processors for nothing.Handlers should still check the record levels within handle(), returning false in isHandling() is no guarantee that handle() will not be called, and isHandling() might not be called for a given record.
Parameters
array$recordPartial log record containing only a level key
Returns
bool
} More...
 
 handleBatch (array $records)
 {Handles a set of records at once.
Parameters
array$recordsThe records to handle (an array of record arrays)
} More...
 
 close ()
 Closes the handler. More...
 
 pushProcessor ($callback)
 {Adds a processor in the stack.
Parameters
callable$callback
Returns
self
} More...
 
 popProcessor ()
 {Removes the processor on top of the stack and returns it.
Returns
callable
} More...
 
 setFormatter (FormatterInterface $formatter)
 {Sets the formatter.
Parameters
FormatterInterface$formatter
Returns
self
} More...
 
 getFormatter ()
 {Gets the formatter.
Returns
FormatterInterface
} More...
 
 setLevel ($level)
 Sets minimum logging level at which this handler will be triggered. More...
 
 getLevel ()
 Gets minimum logging level at which this handler will be triggered. More...
 
 setBubble ($bubble)
 Sets the bubbling behavior. More...
 
 getBubble ()
 Gets the bubbling behavior. More...
 
 __destruct ()
 
 reset ()
 

Protected Member Functions

 write (array $record)
 {} More...
 
- Protected Member Functions inherited from Monolog\Handler\AbstractProcessingHandler
 write (array $record)
 Writes the record down to the log of the implementing handler. More...
 
 processRecord (array $record)
 Processes a record. More...
 
- Protected Member Functions inherited from Monolog\Handler\AbstractHandler
 getDefaultFormatter ()
 Gets the default formatter. More...
 

Protected Attributes

 $rollbarNotifier
 
 $levelMap
 
 $initialized = false
 
- Protected Attributes inherited from Monolog\Handler\AbstractHandler
 $level = Logger::DEBUG
 
 $bubble = true
 
 $formatter
 
 $processors = array()
 

Private Attributes

 $hasRecords = false
 

Detailed Description

Sends errors to Rollbar.

If the context data contains a payload key, that is used as an array of payload options to RollbarNotifier's report_message/report_exception methods.

Rollbar's context info will contain the context + extra keys from the log record merged, and then on top of that a few keys:

  • level (rollbar level name)
  • monolog_level (monolog level name, raw level, as rollbar only has 5 but monolog 8)
  • channel
  • datetime (unix timestamp)
Author
Paul Statezny pauls.nosp@m.tate.nosp@m.zny@g.nosp@m.mail.nosp@m..com

Definition at line 34 of file RollbarHandler.php.

Constructor & Destructor Documentation

◆ __construct()

Monolog\Handler\RollbarHandler::__construct ( RollbarNotifier  $rollbarNotifier,
  $level = Logger::ERROR,
  $bubble = true 
)
Parameters
RollbarNotifier$rollbarNotifierRollbarNotifier object constructed with valid token
int$levelThe minimum logging level at which this handler will be triggered
bool$bubbleWhether the messages that are handled can bubble up the stack or not

Definition at line 68 of file RollbarHandler.php.

References Monolog\Handler\AbstractHandler\$bubble, Monolog\Handler\AbstractHandler\$level, and Monolog\Handler\RollbarHandler\$rollbarNotifier.

69  {
70  $this->rollbarNotifier = $rollbarNotifier;
71 
72  parent::__construct($level, $bubble);
73  }

Member Function Documentation

◆ close()

Monolog\Handler\RollbarHandler::close ( )

{}

Definition at line 128 of file RollbarHandler.php.

References Monolog\Handler\RollbarHandler\flush().

129  {
130  $this->flush();
131  }
+ Here is the call graph for this function:

◆ flush()

Monolog\Handler\RollbarHandler::flush ( )

Definition at line 117 of file RollbarHandler.php.

Referenced by Monolog\Handler\RollbarHandler\close(), and Monolog\Handler\RollbarHandler\reset().

118  {
119  if ($this->hasRecords) {
120  $this->rollbarNotifier->flush();
121  $this->hasRecords = false;
122  }
123  }
+ Here is the caller graph for this function:

◆ reset()

Monolog\Handler\RollbarHandler::reset ( )

{}

Implements Monolog\ResettableInterface.

Definition at line 136 of file RollbarHandler.php.

References Monolog\Handler\RollbarHandler\flush().

137  {
138  $this->flush();
139 
140  parent::reset();
141  }
+ Here is the call graph for this function:

◆ write()

Monolog\Handler\RollbarHandler::write ( array  $record)
protected

{}

Definition at line 78 of file RollbarHandler.php.

References $context.

79  {
80  if (!$this->initialized) {
81  // __destructor() doesn't get called on Fatal errors
82  register_shutdown_function(array($this, 'close'));
83  $this->initialized = true;
84  }
85 
86  $context = $record['context'];
87  $payload = array();
88  if (isset($context['payload'])) {
89  $payload = $context['payload'];
90  unset($context['payload']);
91  }
92  $context = array_merge($context, $record['extra'], array(
93  'level' => $this->levelMap[$record['level']],
94  'monolog_level' => $record['level_name'],
95  'channel' => $record['channel'],
96  'datetime' => $record['datetime']->format('U'),
97  ));
98 
99  if (isset($context['exception']) && $context['exception'] instanceof Exception) {
100  $payload['level'] = $context['level'];
101  $exception = $context['exception'];
102  unset($context['exception']);
103 
104  $this->rollbarNotifier->report_exception($exception, $context, $payload);
105  } else {
106  $this->rollbarNotifier->report_message(
107  $record['message'],
108  $context['level'],
109  $context,
110  $payload
111  );
112  }
113 
114  $this->hasRecords = true;
115  }
$context
Definition: webdav.php:25

Field Documentation

◆ $hasRecords

Monolog\Handler\RollbarHandler::$hasRecords = false
private

Definition at line 59 of file RollbarHandler.php.

◆ $initialized

Monolog\Handler\RollbarHandler::$initialized = false
protected

Definition at line 61 of file RollbarHandler.php.

◆ $levelMap

Monolog\Handler\RollbarHandler::$levelMap
protected
Initial value:
= array(
Logger::DEBUG => 'debug',
Logger::INFO => 'info',
Logger::NOTICE => 'info',
Logger::WARNING => 'warning',
Logger::ERROR => 'error',
Logger::CRITICAL => 'critical',
Logger::ALERT => 'critical',
Logger::EMERGENCY => 'critical',
)

Definition at line 43 of file RollbarHandler.php.

◆ $rollbarNotifier

Monolog\Handler\RollbarHandler::$rollbarNotifier
protected

Definition at line 41 of file RollbarHandler.php.

Referenced by Monolog\Handler\RollbarHandler\__construct().


The documentation for this class was generated from the following file: