[CalendarServer-changes] [4657] CalendarServer/trunk/doc/Admin/ExtendedLogItems.txt

[source_changes at macosforge.org]

Revision: 4657
          http://trac.macosforge.org/projects/calendarserver/changeset/4657
Author:   wsanchez at apple.com
Date:     2009-10-28 17:19:02 -0700 (Wed, 28 Oct 2009)
Log Message:
-----------
ReSTify

Modified Paths:
--------------
    CalendarServer/trunk/doc/Admin/ExtendedLogItems.txt

Modified: CalendarServer/trunk/doc/Admin/ExtendedLogItems.txt
===================================================================
--- CalendarServer/trunk/doc/Admin/ExtendedLogItems.txt	2009-10-28 23:23:50 UTC (rev 4656)
+++ CalendarServer/trunk/doc/Admin/ExtendedLogItems.txt	2009-10-29 00:19:02 UTC (rev 4657)
@@ -1,3 +1,6 @@
+Apache-style Access Log Extensions
+==================================
+
 Calendar Server extends the Apache log file format it uses by:
 
  * Adding a "sub-method" to the HTTP method field.
@@ -6,47 +9,51 @@
 The sub-method is adding by appending the name of the sub-method in
 parentheses to the original HTTP request method.  This is used to
 clarify what operation is going on for HTTP methods that are commonly
-used to tunnel other operations, such as POST and REPORT.  For
-example, CalDAV uses POST for free/busy lookups, and there are many
-types of REPORTs.
+used to tunnel other operations, such as ``POST`` and ``REPORT``.  For
+example, CalDAV uses ``POST`` for free/busy lookups, and there are
+many types of ``REPORT``s.
 
 Key-value pairs are used to provide additional details about the
 request.  They are added to the end of the line as new fields in the
-form key=value.
+form ``key=value``.
 
 These keys are always emitted:
 
- * i - the port number of the server instance emitting the log entry.
+ * ``i`` - the port number of the server instance emitting the log
+   entry.
 
- * t - the amount of time spent processing the request (in
+ * ``t`` - the amount of time spent processing the request (in
    milliseconds).
 
- * or - the number of outstanding requests enqueued for the server
+ * ``or`` - the number of outstanding requests enqueued for the server
    instance emitting the log entry.
 
 Keys that may be emitted depending on the client request and server
 response include:
 
- * rcount - the number of resources specified in a MULTIGET request.
+ * ``rcount`` - the number of resources specified in a ``MULTIGET``
+   request.
 
- * responses - the number of responses included in a multi-status
-   response to a PROPFIND request or a CalDAV calendar-query request.
+ * ``responses`` - the number of responses included in a
+   ``multi-status`` response to a ``PROPFIND`` request or a CalDAV
+   ``calendar-query`` request.
 
- * recipients - the number of recipients in a CalDAV scheduling
-   request via POST (which are typically only freebusy requests).
+ * ``recipients`` - the number of recipients in a CalDAV scheduling
+   request via ``POST`` (which are typically only free/busy requests).
 
- * itip.requests - the number of attendees in an implicit scheduling
+ * ``itip.requests`` - the number of attendees in a scheduling
    operation triggered by an Organizer.
 
- * itip.refreshes - the number of attendee refreshes completed after
-   an implicit scheduling operation.
+ * ``itip.refreshes`` - the number of attendee refreshes completed
+   after a scheduling operation.
 
- * itip.reply - "reply" or "cancel" if...???
+ * ``itip.reply`` - Either ``reply`` or ``cancel`` depending on...???
 
-In this example, we see a CalDAV:calendar-multiget REPORT for 32
-resources in a user's calendar, which was handled by instance 8459 in
-183.0ms, with one outstanding request (the one being logged):
+In the following example, we see a ``CalDAV:calendar-multiget``
+``REPORT`` for 32 resources in a user's calendar, which was handled by
+instance ``8459`` in 183.0ms, with one outstanding request (the one
+being logged):
 
-{{{
-17.108.160.37 - scastillo [15/Sep/2009:20:10:23 +0000] "REPORT(CalDAV:calendar-multiget) /calendars/__uids__/B8CE9430-965B-11DE-B626-EC2E9DB52B69/calendar/ HTTP/1.1" 207 149285 "-" "DAVKit/4.0 (729); CalendarStore/4.0 (965); iCal/4.0 (1362); Mac OS X/10.6.1 (10B504)" i=8459 t=183.0 or=1 rcount=32
-}}}
+::
+
+  17.108.160.37 - scastillo [15/Sep/2009:20:10:23 +0000] "REPORT(CalDAV:calendar-multiget) /calendars/__uids__/B8CE9430-965B-11DE-B626-EC2E9DB52B69/calendar/ HTTP/1.1" 207 149285 "-" "DAVKit/4.0 (729); CalendarStore/4.0 (965); iCal/4.0 (1362); Mac OS X/10.6.1 (10B504)" i=8459 t=183.0 or=1 rcount=32
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/calendarserver-changes/attachments/20091028/0f5e00f1/attachment.html>