function DbLog::log

Same name in other branches
  1. 9 core/modules/dblog/src/Logger/DbLog.php \Drupal\dblog\Logger\DbLog::log()
  2. 8.9.x core/modules/dblog/src/Logger/DbLog.php \Drupal\dblog\Logger\DbLog::log()
  3. 11.x core/modules/dblog/src/Logger/DbLog.php \Drupal\dblog\Logger\DbLog::log()

Overrides RfcLoggerTrait::log

File

core/modules/dblog/src/Logger/DbLog.php, line 55

Class

DbLog
Logs events in the watchdog database table.

Namespace

Drupal\dblog\Logger

Code

public function log($level, string|\Stringable $message, array $context = []) : void {
    // Remove backtrace and exception since they may contain an unserializable variable.
    unset($context['backtrace'], $context['exception']);
    // Convert PSR3-style messages to \Drupal\Component\Render\FormattableMarkup
    // style, so they can be translated too in runtime.
    $message_placeholders = $this->parser
        ->parseMessagePlaceholders($message, $context);
    try {
        $this->connection
            ->insert('watchdog')
            ->fields([
            'uid' => $context['uid'],
            'type' => mb_substr($context['channel'], 0, 64),
            'message' => $message,
            'variables' => serialize($message_placeholders),
            'severity' => $level,
            'link' => $context['link'],
            'location' => $context['request_uri'],
            'referer' => $context['referer'],
            'hostname' => mb_substr($context['ip'], 0, 128),
            'timestamp' => $context['timestamp'],
        ])
            ->execute();
    } catch (\Exception $e) {
        // When running Drupal on MySQL or MariaDB you can run into several errors
        // that corrupt the database connection. Some examples for these kind of
        // errors on the database layer are "1100 - Table 'xyz' was not locked
        // with LOCK TABLES" and "1153 - Got a packet bigger than
        // 'max_allowed_packet' bytes". If such an error happens, the MySQL server
        // invalidates the connection and answers all further requests in this
        // connection with "2006 - MySQL server had gone away". In that case the
        // insert statement above results in a database exception. To ensure that
        // the causal error is written to the log we try once to open a dedicated
        // connection and write again.
        if (($e instanceof DatabaseException || $e instanceof \PDOException) && $this->connection
            ->getTarget() != self::DEDICATED_DBLOG_CONNECTION_TARGET) {
            // Open a dedicated connection for logging.
            $key = $this->connection
                ->getKey();
            $info = Database::getConnectionInfo($key);
            Database::addConnectionInfo($key, self::DEDICATED_DBLOG_CONNECTION_TARGET, $info['default']);
            $this->connection = Database::getConnection(self::DEDICATED_DBLOG_CONNECTION_TARGET, $key);
            // Now try once to log the error again.
            $this->log($level, $message, $context);
        }
        else {
            throw $e;
        }
    }
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.