W3C home > Mailing lists > Public > www-validator-cvs@w3.org > June 2004

perl/modules/W3C/LogValidator/samples logprocess.conf,1.9,1.10

From: Olivier Thereaux <ot@dev.w3.org>
Date: Mon, 07 Jun 2004 14:15:09 +0000
To: www-validator-cvs@w3.org
Message-Id: <20040607141509.0A8CD4A852@hutz.w3.org>

Update of /sources/public/perl/modules/W3C/LogValidator/samples
In directory hutz:/tmp/cvs-serv678

Modified Files:
	logprocess.conf 
Log Message:
general refactoring of the sample config file - more explanations
 
- adding NEW configuration option MaxDocuments
- adding a way to set AuthorizedExtensions for each module 



Index: logprocess.conf
===================================================================
RCS file: /sources/public/perl/modules/W3C/LogValidator/samples/logprocess.conf,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -d -r1.9 -r1.10
--- logprocess.conf	2 Jun 2004 07:50:54 -0000	1.9
+++ logprocess.conf	7 Jun 2004 14:15:06 -0000	1.10
@@ -1,90 +1,165 @@
-## configuration file for the Log Validator
-## most of the directives can be taken from the Apache configuration format
-## and have the same meaning and syntax
+###############################################################################
+##                                                                           ##
+##     logprocess.conf - sample configuration file for the Log Validator     ##
+##                                                                           ##
+##                                                                           ##
+##               Written by olivier Thereaux for W3C                         ##
+##                                                                           ##
+##     most of the directives can be taken from the Apache configuration     ##
+##                  and have the same meaning and syntax                     ##
+##                                                                           ##
+###############################################################################
+# $id $
 
-## [apache] ServerRoot : base path for all files and paths
-## NOT IMPLEMENTED YET
-## only one allowed
-ServerRoot /etc/apache/
-#ServerRoot /usr/local/apache/
 
-## [apache] ServerAdmin : e-mail address to send the reports
-## only one allowed
+#####################################
+##                                 ##
+##   General server configuration  ##
+##                                 ##
+#####################################
+##
+##     Configuration variables about the Web server being tested
+##      Used by the LogValidator to find and analyse log files
+##      NOTE: [apache] means you should safely be able to copy 
+## the equivalent line from the configuration of an Apache Web server
+
+##  [apache] ServerAdmin : e-mail address to send the reports  ##
+##
 ServerAdmin me@my.domain
 
-## MailFrom : if not set, Log Validator will use the same address for
-## From: and To: when sending e-mail. Use this to set a specific From:
+##  MailFrom : From: address for e-mail output  ##
+##
+## Unless the relevant option is specified when running the LogValidator,
+## the mail output will use ServerAdmin (see above) as From: and To:
+## This option allows you to override the From: parameter
+## DEFAULT  = ServerAdmin
 # MailFrom: logvalidator@example.org
 
-## [apache] DocumentRoot : where the files are located. useful for some log formats
-## only one allowed
+##  [apache] DocumentRoot : where the files are located  ## 
+##
+## For some log formats, it is necessary to know where the actual files
+## reside on the server
 DocumentRoot /var/www/
 
-## [apache] ServerName : full address for the web server, i.e host.domain
+##  [apache] ServerName : full address for the web server  ##
+##
+## should be of the form host.domain
+## NOTE: no need to prepend http://
 ServerName my.web.site
 
-## [apache] LogFormat : add a non-standard log format
-## NOT IMPLEMENTED YET
-## not needed if the log format is based on the CLF, like common, combined, full
-## multiple entries allowed
-## see http://httpd.apache.org/docs/mod/mod_log_config.html#logformat
-# LogFormat "%h %l %u %t \"%r\" %>s %b" common
-
-## [apache] CustomLog : log file and format
-## see http://httpd.apache.org/docs/mod/mod_log_config.html
-## multiple entries allowed
-# WARNING! only the following formats are currently supported:
-# common, combined, w3, full, plain (list of addresses)
+##  [apache] CustomLog : log file and format  ##
+##
+## Add as many entries as you like. The Log Validator will process all log files listed below
+## formats: see http://httpd.apache.org/docs/mod/mod_log_config.html
+#  NOTE: only the following formats are currently supported:
+#                    common, combined, w3, full, plain (list of addresses)
 CustomLog /var/log/apache/access.log combined
-# CustomLog logs/lagrange-access_log combined
+# CustomLog /var/log/apache/access.log.1 combined
+# CustomLog /home/me/path/to/list plain
 
-## How many log entries do we process per log file?
-## can be useful for very (too) big log files.
-## set to 0 for no limit - not recommended
-# EntriesPerLogfile 5000
+## [apache] DirectoryIndex : document equivalent to "/"
+##
+## See http://httpd.apache.org/docs/mod/mod_dir.html#directoryindex
+## Used by the validator to compute the "canonical" URLs for Documents
+## DEFAULT = index.html index.htm index
+# DirectoryIndex index.html index.htm index Overview Overview.html Overview.xhtml
 
 
-## [apache] DirectoryIndex :
-## see http://httpd.apache.org/docs/mod/mod_dir.html#directoryindex
-## only one allowed
-DirectoryIndex index.html index.htm index Overview Overview.html Overview.xhtml
+####################################
+##                                ##
+##  General Log Validator config  ##
+##                                ##
+####################################
 
-## MaxInvalid : how many documents the modules need to find "invalid" before exiting
-## only one allowed, but can be changed for each module
-MaxInvalid 10
+
+##  EntriesPerLogFile : How many log entries do we process per log file? ##
+##
+## If log files are very big, the Log Validator will only process the first n entries (lines)
+## This parameter can be sent to any number. 
+## NOTE: Set it to 0 for "no limit" (not recommended)
+## DEFAULT = 100000
+# EntriesPerLogfile 5000
+
+## MaxInvalid : how many "invalid" documents to find before exiting
+##
+## Most Log Validator processing modules will find "invalid" documents (the definition varies)
+## This is the general configuration variable for how many documents processing
+##   modules should look for in the global list of documents before exiting
+## NOTE: this can be fine-tuned on a per-module basis by setting this variable
+##  In the config file for each module
+## NOTE: See also MaxDocuments
+## NOTE: Set it to 0 for "no limit"
+## DEFAULT = 10
+# MaxInvalid 20
+
+## MaxDocuments : how many documents to process before exiting [NEW version 0.3]
+##
+## All Log Validator processing modules will stop after processing this number of documents
+##   Even if the limit set for the number of Invalid
+## For purely statistical modules, this will be the only limit
+## 0 is equivalent to infinite (i.e process all the entries in the log as defined by EntriesPerLogfile
+## NOTE: this can be fine-tuned by setting the same variable for each module
+## NOTE: See also MaxDocuments
+## NOTE: Set it to 0 for "no limit"
+## DEFAULT =  0
+#MaxDocuments 100
 
 ## UseValidationModule : chooses between available modules to process the logs
-## multiple entries allowed
+##
+## Below is the list of modules shipped with the Log Validator
+## uncomment the lines for the ones you want to use
+## or add your own
 UseValidationModule W3C::LogValidator::HTMLValidator
 UseValidationModule W3C::LogValidator::CSSValidator
 UseValidationModule W3C::LogValidator::Basic
 
-## specific/overriden variables for the HTMLValidator module
+
+#####################################
+##                                 ##
+##  Module-Specific configuration  ##
+##                                 ##
+#####################################
+##
+## Below are specific configuration directives for some of the modules
+
+
 <Module W3C::LogValidator::HTMLValidator>
-## you can change the maxinvalid number
+## MaxDocuments and MaxInvalid 
+## 
+## how many documents should be processed and/or how many invalid documents need to be found
+##   before this particular module stops processing the longs
+## DEFAULT = global values of MaxInValid and MaxDocuments
+## 
 ## MaxInvalid 5
+## MaxDocuments 0
 
-## verbosity - you can overrride the setting given at the commandline
-# verbose 0
-
-## other variables you may change *WARNING* at your own risks *WARNING*
-## default should be fine, don't change this unless you know what you're doing
+## Other variables you may change *WARNING* at your own risks *WARNING*
+## NOTE: default should be fine, don't change this unless you know what you're doing
+## Below are the default values, uncomment and modify if necessary
 # ValidatorMethod HEAD
 # ValidatorHost validator.w3.org
 # ValidatorPort 80
 # ValidatorString /check?uri=
 # ValidatorPostString \;output=xml
-# AuthorizedExtensions : what kind of extensions the module should claim responsibility for
-# AuthorizedExtensions .html .xhtml .phtml .htm /
+# AuthorizedExtensions .html .xhtml .phtml .htm .shtml .php .svg .xml /
 </Module>
 
 
-## specific/overriden variables for the CSSValidator module
 <Module W3C::LogValidator::CSSValidator>
-## you can change the maxinvalid number
+## MaxDocuments and MaxInvalid 
+## 
+## how many documents should be processed and/or how many invalid documents need to be found
+##   before this particular module stops processing the longs
+## DEFAULT = global values of MaxInValid and MaxDocuments
+## 
 ## MaxInvalid 5
+## MaxDocuments 0
 
-## verbosity - you can overrride the setting given at the commandline
+## verbose: amount of output when running Log Validator
+##
+## verbosity is set up for the whole Log Validator frm the command line
+##   but if you want a specific verbosity for a specific module, override the setting here
+## DEFAULT = global value of verbose
 # verbose 0
 
 ## other variables you may change *WARNING* at your own risks *WARNING*
@@ -93,5 +168,4 @@
 # default is the latter
 #AuthorizedExtensions .css 
 #AuthorizedExtensions .html .xhtml .phtml .htm .css .svg /
-
 </Module>
Received on Monday, 7 June 2004 10:15:09 UTC

This archive was generated by hypermail 2.4.0 : Friday, 17 January 2020 23:02:06 UTC