You are here

Home » API reference » File Log 7

README.txt in File Log 7

Same filename and directory in other branches
  1. 6.2 README.txt
  2. 6 README.txt
// $Id$

===============================================================================
File logging
===============================================================================
A watchdog interface implementation which records system events directly into
files. This is an alternative to the Syslog core module.


===============================================================================
Configuration
===============================================================================
The project is configurable through the $conf array under the key 'filelog' in
the site's settings.php (DRUPAL/sites/<site directory>/settings.php).

All directive is optional.

Example configuration:

$conf['filelog'] = array(
  'dir' => '/var/log/drupal/example.com',
  'log_level' => WATCHDOG_INFO,
  'site_in_name' => TRUE,
  'type_in_name' => TRUE,
  'severity_in_name' => TRUE,
  'grouped_severity_in_name' => TRUE,
  'daily_files' => TRUE,
  'delete_files' => 7,
  'field_separator' => ' | ',
  'field_prefix' => '[',
  'field_suffix' => ']',
  'wrap_message' => TRUE,
  'log_base_url' => TRUE,
  'log_username' => TRUE,
  'date_format' => 'medium',
  'decode_severity' => TRUE,
  'skip_strip_tags' => TRUE,
);

Logging directives:
-------------------
dir
  Log directory. Defaults to sites/<site directory>/logs.
  CAN'T CONTAIN TRAILING SLASH!

log_level
  Maximum severity (inclusive) to log from WATCHDOG_EMERG(0) to
  WATCHDOG_DEBUG(7). Defaults to WATCHDOG_DEBUG.

site_in_name
  Add the name of the configuration directory (when TRUE) or the configured
  string to the file name.

type_in_name
  Add the $type argument of watchdog() to the file name.

severity_in_name
  Add the decoded severity to the file name.

grouped_severity_in_name
  Add one of the following parts to the file name:
    debug: WATCHDOG_DEBUG;
    info: WATCHDOG_INFO, WATCHDOG_NOTICE, WATCHDOG_WARNING;
    error: all other levels.
  Used only when NOT severity_in_name.

daily_files
  Add the the current day's timestamp to the file name in the form YYYYMMDD.

delete_files
  Delete log files after the configured DAYS during cron run. Used only when
  daily_files is enabled.

Theming directives:
-------------------
field_separator
  Text to use to separe fields in records.

field_prefix
  Text to use to prefix fields in records.

field_suffix
  Text to use to suffix fields in records.

wrap_message
  Add the prefix and suffix to the message field, too.

log_base_url
  Add the base url to the record.

log_username
  Add the username to the record instead of the UID.

date_format
  Controls how to format the timestamp in the record.
  Possible values are 'small', 'medium', 'large' or a custom format acceptable
  by format_date().

decode_severity
  Add severity to the record as text not as number.

skip_strip_tags
  Message and link fields are running through strip_tags() by default.


===============================================================================
Install, unistall
===============================================================================
Configuration must be done before install!

Backup should be done before uninstall!


===============================================================================
Maintainer
===============================================================================
István Németh <i.nemeth@xmarket.hu>
              http://drupal.org/user/231445

File

README.txt
View source 
  1. // $Id$

  2. 

  3. ===============================================================================

  4. File logging

  5. ===============================================================================

  6. A watchdog interface implementation which records system events directly into

  7. files. This is an alternative to the Syslog core module.

  8. 

  9. 

  10. ===============================================================================

  11. Configuration

  12. ===============================================================================

  13. The project is configurable through the $conf array under the key 'filelog' in

  14. the site's settings.php (DRUPAL/sites//settings.php).

  15. 

  16. All directive is optional.

  17. 

  18. Example configuration:

  19. 

  20. $conf['filelog'] = array(

  21.   'dir' => '/var/log/drupal/example.com',

  22.   'log_level' => WATCHDOG_INFO,

  23.   'site_in_name' => TRUE,

  24.   'type_in_name' => TRUE,

  25.   'severity_in_name' => TRUE,

  26.   'grouped_severity_in_name' => TRUE,

  27.   'daily_files' => TRUE,

  28.   'delete_files' => 7,

  29.   'field_separator' => ' | ',

  30.   'field_prefix' => '[',

  31.   'field_suffix' => ']',

  32.   'wrap_message' => TRUE,

  33.   'log_base_url' => TRUE,

  34.   'log_username' => TRUE,

  35.   'date_format' => 'medium',

  36.   'decode_severity' => TRUE,

  37.   'skip_strip_tags' => TRUE,

  38. );

  39. 

  40. Logging directives:

  41. -------------------

  42. dir

  43.   Log directory. Defaults to sites//logs.

  44.   CAN'T CONTAIN TRAILING SLASH!

  45. 

  46. log_level

  47.   Maximum severity (inclusive) to log from WATCHDOG_EMERG(0) to

  48.   WATCHDOG_DEBUG(7). Defaults to WATCHDOG_DEBUG.

  49. 

  50. site_in_name

  51.   Add the name of the configuration directory (when TRUE) or the configured

  52.   string to the file name.

  53. 

  54. type_in_name

  55.   Add the $type argument of watchdog() to the file name.

  56. 

  57. severity_in_name

  58.   Add the decoded severity to the file name.

  59. 

  60. grouped_severity_in_name

  61.   Add one of the following parts to the file name:

  62.     debug: WATCHDOG_DEBUG;

  63.     info: WATCHDOG_INFO, WATCHDOG_NOTICE, WATCHDOG_WARNING;

  64.     error: all other levels.

  65.   Used only when NOT severity_in_name.

  66. 

  67. daily_files

  68.   Add the the current day's timestamp to the file name in the form YYYYMMDD.

  69. 

  70. delete_files

  71.   Delete log files after the configured DAYS during cron run. Used only when

  72.   daily_files is enabled.

  73. 

  74. Theming directives:

  75. -------------------

  76. field_separator

  77.   Text to use to separe fields in records.

  78. 

  79. field_prefix

  80.   Text to use to prefix fields in records.

  81. 

  82. field_suffix

  83.   Text to use to suffix fields in records.

  84. 

  85. wrap_message

  86.   Add the prefix and suffix to the message field, too.

  87. 

  88. log_base_url

  89.   Add the base url to the record.

  90. 

  91. log_username

  92.   Add the username to the record instead of the UID.

  93. 

  94. date_format

  95.   Controls how to format the timestamp in the record.

  96.   Possible values are 'small', 'medium', 'large' or a custom format acceptable

  97.   by format_date().

  98. 

  99. decode_severity

  100.   Add severity to the record as text not as number.

  101. 

  102. skip_strip_tags

  103.   Message and link fields are running through strip_tags() by default.

  104. 

  105. 

  106. ===============================================================================

  107. Install, unistall

  108. ===============================================================================

  109. Configuration must be done before install!

  110. 

  111. Backup should be done before uninstall!

  112. 

  113. 

  114. ===============================================================================

  115. Maintainer

  116. ===============================================================================

  117. István Németh 

  118.               http://drupal.org/user/231445