DebugLogPlugin

<--
   Contributions to this plugin are appreciated. Please update the plugin page at
   http://twiki.org/cgi-bin/view/Plugins/DebugLogPlugin or provide feedback at
   http://twiki.org/cgi-bin/view/Plugins/DebugLogPluginDev.
   If you are a TWiki contributor please update the plugin in the SVN repository.

One line description, required for extensions repository catalog. 

 Set SHORTDESCRIPTION = Detailed debug logging of CGI requests for TWiki
 
-->

Usage

This Plugin creates a transaction log containing all the CGI parameters sent to TWiki for every request. To avoid locking and time serialization effects, each TWiki request is placed into a separate file in twiki/working/work_areas/DebugLogPlugin/. Files are uniquely named, using this example pattern: 2021-01-24-10-15-45-466-POST-save-Sandbox.TestDebugLogPlugin-TWikiGuest-3.221.159.255.

Installation Instructions

You do not need to install anything in the browser to use this extension. The following instructions are for the administrator who installs the extension on the server where TWiki is running.

Like many other TWiki extensions, this module is shipped with a fully automatic installer script written using the BuildContrib.

• If you have TWiki 4.2 or later, you can install from the configure interface (Go to Plugins->Find More Extensions)
  • See the installation supplement on TWiki.org for more information.
• If you have any problems, then you can still install manually from the command-line:
  1. Download one of the .zip or .tgz archives
  2. Unpack the archive in the root directory of your TWiki installation.
  3. Run the installer script ( perl <module>_installer )
  4. Run configure and enable the module, if it is a plugin.
  5. Repeat for any missing dependencies.
• If you are still having problems, then instead of running the installer script:
  1. Make sure that the file permissions allow the webserver user to access all files.
  2. Check in any installed files that have existing ,v files in your existing install (take care not to lock the files when you check in)
  3. Manually edit LocalSite.cfg to set any configuration variables.

Plugin Info

Plugin Author(s):	TWiki:Main.SvenDowideit
Copyright:	© 2008 TWiki:Main.SvenDowideit; © 2008-2010, TWiki:TWiki.TWikiContributor
License:	GPL (Gnu General Public License)
Plugin Version:	19401 (2010-08-29)
Change History:	<-- versions below in reverse order -->
2010-08-28:	TWikibug:Item6530: Change debug filenames to be named chronologically; fix for TWiki-5.0; doc improvements; change TWIKIWEB to SYSTEMWEB -- TWiki:Main.PeterThoeny
2008-01-17:	Initial release
Dependencies:	None
Plugin Home:	http://twiki.org/cgi-bin/view/Plugins/DebugLogPlugin
Feedback:	http://twiki.org/cgi-bin/view/Plugins/DebugLogPluginDev
Appraisal:	http://twiki.org/cgi-bin/view/Plugins/DebugLogPluginAppraisal

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences