You are here

Home » API reference » File Log 6

README.txt in File Log 6

Same filename and directory in other branches
  1. 6.2 README.txt
  2. 7 README.txt
===============================================================================
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. 

  2. ===============================================================================

  3. File logging

  4. ===============================================================================

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

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

  7. 

  8. 

  9. ===============================================================================

  10. Configuration

  11. ===============================================================================

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

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

  14. 

  15. All directive is optional.

  16. 

  17. Example configuration:

  18. 

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

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

  21.   'log_level' => WATCHDOG_INFO,

  22.   'site_in_name' => TRUE,

  23.   'type_in_name' => TRUE,

  24.   'severity_in_name' => TRUE,

  25.   'grouped_severity_in_name' => TRUE,

  26.   'daily_files' => TRUE,

  27.   'delete_files' => 7,

  28.   'field_separator' => ' | ',

  29.   'field_prefix' => '[',

  30.   'field_suffix' => ']',

  31.   'wrap_message' => TRUE,

  32.   'log_base_url' => TRUE,

  33.   'log_username' => TRUE,

  34.   'date_format' => 'medium',

  35.   'decode_severity' => TRUE,

  36.   'skip_strip_tags' => TRUE,

  37. );

  38. 

  39. Logging directives:

  40. -------------------

  41. dir

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

  43.   CAN'T CONTAIN TRAILING SLASH!

  44. 

  45. log_level

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

  47.   WATCHDOG_DEBUG(7). Defaults to WATCHDOG_DEBUG.

  48. 

  49. site_in_name

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

  51.   string to the file name.

  52. 

  53. type_in_name

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

  55. 

  56. severity_in_name

  57.   Add the decoded severity to the file name.

  58. 

  59. grouped_severity_in_name

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

  61.     debug: WATCHDOG_DEBUG;

  62.     info: WATCHDOG_INFO, WATCHDOG_NOTICE, WATCHDOG_WARNING;

  63.     error: all other levels.

  64.   Used only when NOT severity_in_name.

  65. 

  66. daily_files

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

  68. 

  69. delete_files

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

  71.   daily_files is enabled.

  72. 

  73. Theming directives:

  74. -------------------

  75. field_separator

  76.   Text to use to separe fields in records.

  77. 

  78. field_prefix

  79.   Text to use to prefix fields in records.

  80. 

  81. field_suffix

  82.   Text to use to suffix fields in records.

  83. 

  84. wrap_message

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

  86. 

  87. log_base_url

  88.   Add the base url to the record.

  89. 

  90. log_username

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

  92. 

  93. date_format

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

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

  96.   by format_date().

  97. 

  98. decode_severity

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

  100. 

  101. skip_strip_tags

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

  103. 

  104. 

  105. ===============================================================================

  106. Install, unistall

  107. ===============================================================================

  108. Configuration must be done before install!

  109. 

  110. Backup should be done before uninstall!

  111. 

  112. 

  113. ===============================================================================

  114. Maintainer

  115. ===============================================================================

  116. István Németh 

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