class ContentSyncLog in Content Synchronization 8

Logs events in the cs_log database table.

Hierarchy

• class \Drupal\content_sync\Logger\ContentSyncLog implements \Psr\Log\LoggerInterface uses DependencySerializationTrait, RfcLoggerTrait

File

src/Logger/ContentSyncLog.php, line 18

Namespace

Drupal\content_sync\Logger

class ContentSyncLog implements LoggerInterface {
  use RfcLoggerTrait;
  use DependencySerializationTrait;

  /**
   * The dedicated database connection target to use for log entries.
   */
  const DEDICATED_CSLOG_CONNECTION_TARGET = 'dedicated_cslog';

  /**
   * The database connection object.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * The message's placeholders parser.
   *
   * @var \Drupal\Core\Logger\LogMessageParserInterface
   */
  protected $parser;

  /**
   * Constructs a csLog object.
   *
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection object.
   * @param \Drupal\Core\Logger\LogMessageParserInterface $parser
   *   The parser to use when extracting message variables.
   */
  public function __construct(Connection $connection, LogMessageParserInterface $parser) {
    $this->connection = $connection;
    $this->parser = $parser;
  }

  /**
   * {@inheritdoc}
   */
  public function log($level, $message, array $context = []) {

    // Remove any backtraces since they may contain an unserializable variable.
    unset($context['backtrace']);

    // Convert PSR3-style messages to SafeMarkup::format() style, so they can be
    // translated too in runtime.
    $message_placeholders = $this->parser
      ->parseMessagePlaceholders($message, $context);
    if (Unicode::substr($context['channel'], 0, 64) == "content_sync") {
      try {
        $this->connection
          ->insert('cs_logs')
          ->fields([
          'uid' => $context['uid'],
          'type' => Unicode::substr($context['channel'], 0, 64),
          'message' => $message,
          'variables' => serialize($message_placeholders),
          'severity' => $level,
          'link' => $context['link'],
          'location' => $context['request_uri'],
          'referer' => $context['referer'],
          'hostname' => Unicode::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_CSLOG_CONNECTION_TARGET) {

          // Open a dedicated connection for logging.
          $key = $this->connection
            ->getKey();
          $info = Database::getConnectionInfo($key);
          Database::addConnectionInfo($key, self::DEDICATED_CSLOG_CONNECTION_TARGET, $info['default']);
          $this->connection = Database::getConnection(self::DEDICATED_CSLOG_CONNECTION_TARGET, $key);

          // Now try once to log the error again.
          $this
            ->log($level, $message, $context);
        }
        else {
          throw $e;
        }
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ContentSyncLog::$connection	protected	property	The database connection object.
ContentSyncLog::$parser	protected	property	The message's placeholders parser.
ContentSyncLog::DEDICATED_CSLOG_CONNECTION_TARGET		constant	The dedicated database connection target to use for log entries.
ContentSyncLog::log	public	function	Logs with an arbitrary level. Overrides RfcLoggerTrait::log
ContentSyncLog::__construct	public	function	Constructs a csLog object.
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
RfcLoggerTrait::alert	public	function
RfcLoggerTrait::critical	public	function
RfcLoggerTrait::debug	public	function
RfcLoggerTrait::emergency	public	function
RfcLoggerTrait::error	public	function
RfcLoggerTrait::info	public	function
RfcLoggerTrait::notice	public	function
RfcLoggerTrait::warning	public	function