COMMON LOGGING FORMAT

[Alexey M. <al...@hs...>]

Questions: 

	   - are there any more logging objects?

	   - should we have additional functionality beyond simply
	     substituting the variables?  I can't imagine any.

	   - what are the exact points where log file format could be
	     overriden? per-repository (ok)?  per-module (oh, no!)?
	     per-branch???



======================================================================

COMMON LOGGING FORMAT
======================


Logging objects
----------------

There are the following variables that are associated with each server
action:


Timestamp (T):

	time of the operation


Username (U):  

	name of the user working with server

IP-Address (I): 

	IP-address of user working with server (or "<local>", if
	working with


Repository (R):

	path to the repository


Module (M):

	CVS module name


Subcommand (S):

	CVS sub-command ('checkin', 'add', etc.)


Branch (B):

	branch we are working on


Filename (F):

	file we are working with


Revision (r):

	revision we are working with (or "-" if not applicable).

Info (i):

	additional information specific for particular sub-command.




Log file format
----------------

Log file format is specifed a-la mod_log_config, using the
/etc/cvs-server.conf:

	# This will output all the information
	CustomLog /var/log/cvs-server.log "%T %R %U %I %M %S %B %F %r %i"


This could be overriden on a per-repository basis from the
CVSROOT/config file.



Log file filtering
-------------------

Someday we could implement the logfile filtering, using the following
notation:

	# for all 'cvs rtag' commands, output the brief tag information
	FilterLog /var/log/branches.log "%{S=rtag} "%T %U %I %M %B %i"


Probably we should not bother with it currently, because it could be
easily done with a one-line Perl script.  But maybe there could really
be the rationale for actually doing it on a server side.



--alexm