summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChristian Wyglendowski <none@none>2005-09-24 20:12:18 +0000
committerChristian Wyglendowski <none@none>2005-09-24 20:12:18 +0000
commitc680512c4dd7d68de5434eb5199542c17fcf41b7 (patch)
treefb0fbd70a329d525578aec609125d78d798dca02 /docs
parent3fc376cb6eeede5b46f50fa80825017ec92976b6 (diff)
downloadcherrypy-git-c680512c4dd7d68de5434eb5199542c17fcf41b7.tar.gz
Added descriptions of all the core config options that I am aware of related to logging.
Diffstat (limited to 'docs')
-rw-r--r--docs/book/xml/configreference.xml12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/book/xml/configreference.xml b/docs/book/xml/configreference.xml
index adffd317..38a5f6e1 100644
--- a/docs/book/xml/configreference.xml
+++ b/docs/book/xml/configreference.xml
@@ -11,6 +11,18 @@
<para><option>[global] server.socketPort</option>: port number where the server is listening (defaults to 8080)</para>
</listitem>
<listitem>
+ <para><option>[global] server.logFile</option>: path to a file to log CherryPy server activity. Items logged include startup config info, tracebacks and HTTP requests. It is disabled by default and everything is logged to the screen.</para>
+ </listitem>
+ <listitem>
+ <para><option>[global] server.logAccessFile</option>: path to a file where access log data will be stored in Common Log Format. The default is to write access log data to the screen. If a file is specified, the access log data is no longer written to the screen.</para>
+ </listitem>
+ <listitem>
+ <para><option>[global] server.logToScreen</option>: controls whether any log data is written to the screen. It defaults to on (True). For performance reasons, it is best to have this option turned off on a production server.</para>
+ </listitem>
+ <listitem>
+ <para><option>[global] server.logTracebacks</option>: controls whether or not tracebacks are written to the log (screen or otherwise). Defaults to on (True) If set to False, only a 500 return code will be logged in the access log.</para>
+ </listitem>
+ <listitem>
<para><option>[global] server.maxRequestHeaderSize</option>: maximum acceptable size of a request header, in bytes (defaults to 500KB). If a longer request arrives, the server will interrupt it and return a 413 error. This setting is global (ie: doesn't depend on the path). Set it to zero to remove the limit</para>
</listitem>
<listitem>