How does \Magento\Framework\Logger\Monolog::addRecord() work?

dmitry_fedyuk (Dmitrii Fediuk) March 16, 2016, 8:34am 1

Preliminary context: How does \Magento\Framework\Logger\Monolog::critical() work?

https://github.com/magento/magento2/blob/8fd3e8/lib/internal/Magento/Framework/Logger/Monolog.php#L13-L25

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Logger.php#L242-L250


/**
 * Adds a log record.
 *
 * @param  integer $level   The logging level
 * @param  string  $message The log message
 * @param  array   $context The log context
 * @return Boolean Whether the record has been processed
 */
public function addRecord($level, $message, array $context = array())

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Logger.php#L258-L265


// check if any handler will handle this message so we can return early and save cycles
$handlerKey = null;
foreach ($this->handlers as $key => $handler) {
    if ($handler->isHandling(array('level' => $level))) {
        $handlerKey = $key;
        break;
    }
}

https://github.com/magento/magento2/blob/8fd3e8/app/etc/di.xml#L173-L181

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Handler/HandlerInterface.php#L23-L36


/**
 * 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.
 *
 * @param array $record Partial log record containing only a level key
 *
 * @return Boolean
 */
public function isHandling(array $record);

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Handler/AbstractHandler.php#L18-L23


/**
* Base Handler class providing the Handler structure
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
abstract class AbstractHandler implements HandlerInterface

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Handler/AbstractHandler.php#L44-L50


/**
 * {@inheritdoc}
 */
public function isHandling(array $record)
{
    return $record['level'] >= $this->level;
}

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Logger.php#L275-L283


$record = array(
    'message' => (string) $message,
    'context' => $context,
    'level' => $level,
    'level_name' => $levelName,
    'channel' => $this->name,
    'datetime' => \DateTime::createFromFormat('U.u', sprintf('%.6F', microtime(true)), static::$timezone)->setTimezone(static::$timezone),
    'extra' => array(),
);

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Logger.php#L285-L287


foreach ($this->processors as $processor) {
    $record = call_user_func($processor, $record);
}

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Logger.php#L122-L129


/**
 * Processors that will process all log records
 *
 * To process records of a single handler instead, add the processor on that specific handler
 *
 * @var callable[]
 */
protected $processors;

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Logger.php#L288-L291


while (isset($this->handlers[$handlerKey]) &&
    false === $this->handlers[$handlerKey]->handle($record)) {
    $handlerKey++;
}

https://github.com/magento/magento2/blob/8fd3e8/lib/internal/Magento/Framework/Logger/Handler/System.php#L12-L12

https://github.com/magento/magento2/blob/8fd3e8/lib/internal/Magento/Framework/Logger/Handler/Base.php#L14-L14

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Handler/AbstractProcessingHandler.php#L24-L35


/**
 * {@inheritdoc}
 */
public function handle(array $record)
{
    if (!$this->isHandling($record)) {
        return false;
    }


    $record = $this->processRecord($record);


    $record['formatted'] = $this->getFormatter()->format($record);

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Handler/AbstractHandler.php#L106-L116


/**
 * {@inheritdoc}
 */
public function getFormatter()
{
    if (!$this->formatter) {
        $this->formatter = $this->getDefaultFormatter();
    }


    return $this->formatter;
}

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Formatter/LineFormatter.php#L16-L24


/**
* Formats incoming records into a one-line string
*
* This is especially useful for logging to files
*
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Christophe Coevoet <stof@notk.org>
*/
class LineFormatter extends NormalizerFormatter

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Formatter/NormalizerFormatter.php#L16-L21


/**
* Normalizes incoming records to remove objects/resources so it's easier to dump to various targets
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class NormalizerFormatter implements FormatterInterface

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Formatter/FormatterInterface.php#L19-L27


interface FormatterInterface
{
/**
 * Formats a log record.
 *
 * @param  array $record A record to format
 * @return mixed The formatted record
 */
public function format(array $record);

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Formatter/LineFormatter.php#L69-L85


{
    $vars = parent::format($record);


    $output = $this->format;


    foreach ($vars['extra'] as $var => $val) {
        if (false !== strpos($output, '%extra.'.$var.'%')) {
            $output = str_replace('%extra.'.$var.'%', $this->stringify($val), $output);
            unset($vars['extra'][$var]);
        }
    }


    if ($this->ignoreEmptyContextAndExtra) {
        if (empty($vars['context'])) {
            unset($vars['context']);
            $output = str_replace('%context%', '', $output);
        }

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Formatter/LineFormatter.php#L86-L100




        if (empty($vars['extra'])) {
            unset($vars['extra']);
            $output = str_replace('%extra%', '', $output);
        }
    }


    foreach ($vars as $var => $val) {
        if (false !== strpos($output, '%'.$var.'%')) {
            $output = str_replace('%'.$var.'%', $this->stringify($val), $output);
        }
    }


    return $output;
}

https://github.com/magento/magento2/blob/8fd3e8/lib/internal/Magento/Framework/Logger/Handler/System.php#L43-L59

https://github.com/magento/magento2/blob/8fd3e8/lib/internal/Magento/Framework/Logger/Handler/System.php#L24-L27

https://github.com/magento/magento2/blob/8fd3e8/lib/internal/Magento/Framework/Logger/Handler/System.php#L31-L31

https://github.com/magento/magento2/blob/8fd3e8/lib/internal/Magento/Framework/Logger/Handler/System.php#L36-L36

https://github.com/magento/magento2/blob/8fd3e8/lib/internal/Magento/Framework/Logger/Handler/System.php#L39-L39

https://github.com/magento/magento2/blob/8fd3e8/lib/internal/Magento/Framework/Logger/Handler/Exception.php#L7-L22

github.com

Seldaek/monolog/blob/1.16.0/src/Monolog/Handler/AbstractProcessingHandler.php#L24-L40


/**
 * {@inheritdoc}
 */
public function handle(array $record)
{
    if (!$this->isHandling($record)) {
        return false;
    }


    $record = $this->processRecord($record);


    $record['formatted'] = $this->getFormatter()->format($record);


    $this->write($record);


    return false === $this->bubble;
}

https://github.com/magento/magento2/blob/8fd3e8/lib/internal/Magento/Framework/Logger/Handler/Base.php#L47-L61

How does \Magento\Framework\Logger\Monolog::critical() work?

How to write a message to a log file?

The exceptions are loggged into the var/log/exception.log file

The non-exceptional messages are loggged into the var/log/system.log file

The debug messages are logged into the var/log/debug.log file

How does \Magento\Framework\Logger\Monolog::critical() work?

The default implementation of the \Psr\Log\LoggerInterface is \Magento\Framework\Logger\Monolog

dmitry_fedyuk (Dmitrii Fediuk) March 16, 2016, 8:36am 2

See also: