function watchdog

You are here

7 bootstrap.inc watchdog($type, $message, $variables = array(), $severity = WATCHDOG_NOTICE, $link = NULL)
4.6 bootstrap.inc watchdog($type, $message, $severity = WATCHDOG_NOTICE, $link = NULL)
4.7 bootstrap.inc watchdog($type, $message, $severity = WATCHDOG_NOTICE, $link = NULL)
5 bootstrap.inc watchdog($type, $message, $severity = WATCHDOG_NOTICE, $link = NULL)
6 bootstrap.inc watchdog($type, $message, $variables = array(), $severity = WATCHDOG_NOTICE, $link = NULL)
8 bootstrap.inc watchdog($type, $message, array $variables = NULL, $severity = WATCHDOG_NOTICE, $link = NULL)

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 NULL 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:

$link: A link to associate with the message.

See also

watchdog_severity_levels()

hook_watchdog()

124 calls to watchdog()
actions_do in includes/actions.inc
Performs a given list of actions by executing their callback functions.
actions_save in includes/actions.inc
Saves an action and its user-supplied parameter values to the database.
actions_synchronize in includes/actions.inc
Synchronizes actions that are provided by modules in hook_action_info().
aggregator_aggregator_fetch in modules/aggregator/aggregator.fetcher.inc
Implements hook_aggregator_fetch().
aggregator_form_category_submit in modules/aggregator/aggregator.admin.inc
Form submission handler for aggregator_form_category().

... See full list

18 string references to 'watchdog'
ActionLoopTestCase::testActionLoop in modules/simpletest/tests/actions.test
Set up a loop with 3 - 12 recursions, and see if it aborts properly.
actions_loop_test_trigger_info in modules/simpletest/tests/actions_loop_test.module
Implements hook_trigger_info().
actions_loop_test_watchdog in modules/simpletest/tests/actions_loop_test.module
Implements hook_watchdog().
bootstrap_hooks in includes/bootstrap.inc
Defines the critical hooks that force modules to always be loaded.
CommentActionsTestCase::clearWatchdog in modules/comment/comment.test
Helper function: clear the watchdog.

... See full list

File

includes/bootstrap.inc, line 1704
Functions that need to be loaded on every Drupal request.

Code

function watchdog($type, $message, $variables = array(), $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' => ip_address(),
      
      // 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) {
      module_invoke($module, 'watchdog', $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;
  }
}

Comments

http://api.drupal.org/api/drupal/includes--common.inc/function/watchdog_...

<?php
function watchdog_severity_levels() {
  return array(
   
WATCHDOG_EMERGENCY => t('emergency'),
   
WATCHDOG_ALERT => t('alert'),
   
WATCHDOG_CRITICAL => t('critical'),
   
WATCHDOG_ERROR => t('error'),
   
WATCHDOG_WARNING => t('warning'),
   
WATCHDOG_NOTICE => t('notice'),
   
WATCHDOG_INFO => t('info'),
   
WATCHDOG_DEBUG => t('debug'),
  );
}
?>

To output form id, insert the following into hooks_form_alter function:

watchdog('cg_volunteer', 'cg in form_alter %formly', array('%formly' => $form['#id']), WATCHDOG_NOTICE, $link = NULL);

check /admin/reports/dblog for the output

For debugging use dpm().
http://api.drupal.org/api/devel/devel.module/function/dpm/7
Requires the develmodule, but the output is a lot prettier and it goes to the page and not back in the log.

The comment about t() is confusing because it does not say where the translation should occur. watchdog() invokes dblog_watchdog() in modules/dblog/dblog.module and dblog_watchdog() does not translate anything. The translation has to occur before watchdog() processes the data; You could, in theory, have the following complex code when the message is logged on behalf of another module.
watchdog(t('Name @x', array('@x' => 'A')), t('Message @y @z', array('@y' => 'BBBB')), array('@z' => 'CCCCCCCCCC'));

Well it is true that dblog_watchdog is not translating anything before writing into the db...
-BUT-
It is translating when reading and outputing the log message.
So please just stay with the core documentation and use the watchdog function without the t().
(see function theme_dblog_message() in dblog.admin.inc at line 254)

I found this function useful for reporting the errors on the site.

<?php
/**
* Log and display the error
* @param string $error Error to report
* @param object/array $object Object to include with the log
* @param bool $backtrace TRUE if watchdog log should include full backtrace of the error
*/
function _watchdog_log($error, $object = NULL, $backtrace = TRUE) {
 
$object_msg = $object ? 'Object: ' . var_export($object, TRUE) : '';
 
$bt = $backtrace ? 'Backtrace: ' . var_export(debug_backtrace(), TRUE) : '';
 
watchdog('PHP', "Error message: %error<br>\n%object<br>\n%bt", array('%error' => $error, '%object' => $object_msg, '%bt' => $bt), WATCHDOG_ERROR);
 
$last_id = db_query("SELECT 1", array(), array('return' => Database::RETURN_INSERT_ID));
 
$msg = t("Error: !id", array('!id' => $last_id));
 
$err_msg = user_access('access site reports') ? l($msg, 'admin/reports/event/' . $last_id) : $msg;
 
drupal_set_message($err_msg, 'error');
}
?>

Especially in some try/catch areas:

<?php
     
try {
// some code
     
} catch (Exception $e) {
       
_watchdog_log($e->getMessage());
      }
?>

Using hook_watchdog to spit out the dsm means that you can catch errors thrown elsewhere and filter per your own requirements.

Nice Silicon.
+1.

For example, you can have email notifications for the watchdog error, very useful.