[Erp5-report] r38076 leonardo - /erp5/trunk/utils/Products.LongRequestLogger/README.txt

[nobody at svn.erp5.org]

Author: leonardo
Date: Tue Aug 31 19:00:35 2010
New Revision: 38076

URL: http://svn.erp5.org?rev=38076&view=rev
Log:
Some actual information in the README

Modified:
    erp5/trunk/utils/Products.LongRequestLogger/README.txt

Modified: erp5/trunk/utils/Products.LongRequestLogger/README.txt
URL: http://svn.erp5.org/erp5/trunk/utils/Products.LongRequestLogger/README.txt?rev=38076&r1=38075&r2=38076&view=diff
==============================================================================
--- erp5/trunk/utils/Products.LongRequestLogger/README.txt [utf8] (original)
+++ erp5/trunk/utils/Products.LongRequestLogger/README.txt [utf8] Tue Aug 31 19:00:35 2010
@@ -1,4 +1,56 @@
 Introduction
 ============
 
+This product dumps stack traces of long running requests of a Zope2 instance to
+a log file. If a request takes more than a configured timeout, it's stack trace
+will be dumped periodically to a log file.
+
+Installation
+============
+
+Buildout Installation
+---------------------
+
+Add "Products.LongRequestLogger[standalone]" to the list of eggs of the part
+that defines your Zope instance.
+
+Buildout Installation for Old Zope Versions
+-------------------------------------------
+
+Add "Products.LongRequestLogger[python24]" to the list of eggs of the part
+that defines your Zope instance. This will automatically pull in the
+'threadframe' module which is needed for Python versions less than 2.5.
+
+Manual Installation for Old Zope Versions
+-----------------------------------------
+
+Add the LongRequestLogger package inside your Products instance directory and
+install the 'threadframe' module into the Python interpreter used to run Zope.
+
+Configuration
+=============
+
+Add (or change) the "environment" section of your zope.conf to something like
+this::
+
+    # Products.LongRequestLogger config
+    <environment>
+          longrequestlogger_file $INSTANCE/log/longrequest.log
+          longrequestlogger_timeout 4
+          longrequestlogger_interval 2
+    </environment>
+
+The following variables are recognized:
+
+ * "longrequestlogger_file": This is a mandatory variable. Its absence means the
+   LongRequestLogger monkey-patch to the publication machinery will not be
+   applied. It should point to a file where you want the long requests to be
+   logged
+
+ * "longrequestlogger_timeout": The amount of seconds after which long requests
+   start being logged. Accepts floating point values and defaults to 2.
+
+ * "longrequestlogger_interval": The frequency at which long requests will have
+   their stack trace logged once they have exceeded their 'timeout' above.
+   Defaults to 1 and accepts floating point values.