Bug 165589: Add error logging support to Bugzilla (Docs Part)

Patch by: A. Karl Kornel <karl@kornel.name>; r=colin.ogilvie

diff --git a/docs/en/xml/troubleshooting.xml b/docs/en/xml/troubleshooting.xml
index 01ac7fff75a03a1a04ae6ba8483f2307312d0df9..43b1521faa961f0c0d97ca1e3cda7038abbb7bf3 100644 (file)
--- a/docs/en/xml/troubleshooting.xml
+++ b/docs/en/xml/troubleshooting.xml
@@ -1,5 +1,5 @@
 <!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> -->
-<!-- $Id: troubleshooting.xml,v 1.5 2008/04/04 06:48:17 travis%sedsystems.ca Exp $ -->
+<!-- $Id: troubleshooting.xml,v 1.6 2008/04/04 06:48:18 mozilla%colinogilvie.co.uk Exp $ -->
 
 <appendix id="troubleshooting">
 <title>Troubleshooting</title>
@@ -29,6 +29,19 @@
     fix the problem. If not, see below for some commonly-encountered 
     errors. If that doesn't help, post the errors to the newsgroup.
     </para>
+
+    <para>
+      Bugzilla can also log all user-based errors (and many code-based errors)
+      that occur, without polluting the web server error log.  To enable
+      Bugzilla error logging, create a file that Bugzilla can write to, named
+      <filename>errorlog</filename>, in the Bugzilla <filename>data</filename>
+      directory.  Errors will be logged as they occur, and will include the type
+      of the error, the IP address and username (if available) of the user who
+      triggered the error, and the values of all environment variables; if a
+      form was being submitted, the data in the form will also be included.
+      To disable error logging, delete or rename the
+      <filename>errorlog</filename> file.
+    </para>
   </section>
         
   <section id="trbl-testserver">