function watchdog

Logs a system message.

Parameters

$type: The category to which this message belongs. Can be any string, but the general practice is to use the name of the module calling watchdog().

$message: The message to store in the log. Keep $message translatable by not concatenating dynamic values into it! Variables in the message should be added by using placeholder strings alongside the variables argument to declare the value of the placeholders. See t() for documentation on how $message and $variables interact.

$variables: Array of variables to replace in the message on display or array() if message is already translated or not possible to translate.

$severity: The severity of the message; one of the following values as defined in RFC 3164:

• WATCHDOG_EMERGENCY: Emergency, system is unusable.
• WATCHDOG_ALERT: Alert, action must be taken immediately.
• WATCHDOG_CRITICAL: Critical conditions.
• WATCHDOG_ERROR: Error conditions.
• WATCHDOG_WARNING: Warning conditions.
• WATCHDOG_NOTICE: (default) Normal but significant conditions.
• WATCHDOG_INFO: Informational messages.
• WATCHDOG_DEBUG: Debug-level messages.

$link: A link to associate with the message.

See also

watchdog_severity_levels()

hook_watchdog()

File

drupal/core/includes/bootstrap.inc, line 1549

Functions that need to be loaded on every Drupal request.

Code

function watchdog($type, $message, array $variables = NULL, $severity = WATCHDOG_NOTICE, $link = NULL) {
  global $user, $base_root;
  static $in_error_state = FALSE;

  // It is possible that the error handling will itself trigger an error. In that case, we could
  // end up in an infinite loop. To avoid that, we implement a simple static semaphore.
  if (!$in_error_state && function_exists('module_implements')) {
    $in_error_state = TRUE;

    // The user object may not exist in all conditions, so 0 is substituted if needed.
    $user_uid = isset($user->uid) ? $user->uid : 0;

    // Prepare the fields to be logged
    $log_entry = array(
      'type' => $type,
      'message' => $message,
      'variables' => $variables,
      'severity' => $severity,
      'link' => $link,
      'user' => $user,
      'uid' => $user_uid,
      'request_uri' => $base_root . request_uri(),
      'referer' => isset($_SERVER['HTTP_REFERER']) ? $_SERVER['HTTP_REFERER'] : '',
      'ip' => Drupal::request()
        ->getClientIP(),
      // Request time isn't accurate for long processes, use time() instead.
      'timestamp' => time(),
    );

    // Call the logging hooks to log/process the message
    foreach (module_implements('watchdog') as $module) {
      $function = $module . '_watchdog';
      $function($log_entry);
    }

    // It is critical that the semaphore is only cleared here, in the parent
    // watchdog() call (not outside the loop), to prevent recursive execution.
    $in_error_state = FALSE;
  }
}