Logmonster.conf

Sample Logmonster.conf from version 3.01


 * 1) $Id: logmonster.conf 501 2006-10-02 22:31:20Z matt $
 * 2) Logmonster configuration file
 * 1) Logmonster configuration file
 * 1) Logmonster configuration file


 * 1) Logbase - path to Apache logs. Logmonster will figure out exactly where your
 * 2)           logs are based upon $logbase and a combination of the date you are
 * 3)           processing files for.
 * 4)           You are expected to be using cronolog so that log files for a given
 * 5)           period are in a single file, easily found programatically. The easiest
 * 6)           way to do this is with cronolog. Apache recommends using it:
 * 7)           http://httpd.apache.org/docs/misc/FAQ-I.html#rotate
 * 8)           Apache 2.0 expands cronolog support by allowing ErrorLogs to be
 * 9)           piped to cronolog as well.
 * 1)           http://httpd.apache.org/docs/misc/FAQ-I.html#rotate
 * 2)           Apache 2.0 expands cronolog support by allowing ErrorLogs to be
 * 3)           piped to cronolog as well.
 * 1)           piped to cronolog as well.

logbase  = /var/log/http


 * 1) log file owner - the user and group that owns the Apache log files
 * 1) log file owner - the user and group that owns the Apache log files

log_user = www log_group = www


 * 1) tmpdir - the place where logmonster can create temp files. Make sure this
 * 2)          directory exists.
 * 1)          directory exists.

tmpdir   = /var/log/http/tmp


 * 1) statsdir - directory in DocumentRoot where stats are to be stored. This
 * 2)            should be in the form "stats" or some other word like it. If
 * 3)            the VirtulHost DocumentRoot is "/home/example.com/html", then
 * 4)            the stats dir would be "/home/example.com/html/stats". This
 * 5)            directory must be writable by the user Logmonster runs as.
 * 6) statsdir = stats   # default
 * 7)            If the stats directory is fully qualified (begins with a /),
 * 8)            then logmonster will dump stats into a directory that matches
 * 9)            the vhost name within the given directory. Example:
 * 10) statsdir = /www/docroot/stats
 * 11)            For the above setting, stats would be output to this directory:
 * 12)            /www/docroot/stats/example.com
 * 13)            Just like with a normal stats directory, if the directory does
 * 14)            not exist for the virtual domain, then logmonster will skip
 * 15)            processing for that vhost.
 * 1)            Just like with a normal stats directory, if the directory does
 * 2)            not exist for the virtual domain, then logmonster will skip
 * 3)            processing for that vhost.

statsdir = stats


 * 1) statsdir_policy - what to do if the stats dir does not exist
 * 2)  exists - only update their stats if the stats dir exists (default)
 * 3)  create - if the stats dir does not exist, create it
 * 1)  exists - only update their stats if the stats dir exists (default)
 * 2)  create - if the stats dir does not exist, create it

statsdir_policy = exists


 * 1) userlogs - some users want access to their raw HTTP logs. If you host
 * 2)            their site on multiple servers and log directly to their home
 * 3)            directory (from each server), they end up with several log
 * 4)            files, not in sequential order, and log processors can't deal
 * 5)            with that. Instead, send the logs off to /var/log/apache and
 * 6)            at the end of each period, Logmonster will collect the logs
 * 7)            from each server, merge them, feed them through the processor
 * 8)            of your choice, and then drop the logs into the userlogs dir
 * 9)            within DocumentRoot.
 * 10)            I would recommend putting the userlogs outside the DocumentRoot
 * 11)            eg ../logs (Yes it works) so the logs are inaccessible via http.
 * 12)            --Gernot Hueber
 * 1)            eg ../logs (Yes it works) so the logs are inaccessible via http.
 * 2)            --Gernot Hueber

userlogs = logs


 * 1) access - What your http access logs are named. This needs to match the
 * 2)          filename given in the CustomLog directive of httpd.conf
 * 1)          filename given in the CustomLog directive of httpd.conf

access   = access.log


 * 1) error  - What your http error logs are named. This needs to match the
 * 2)          filename given in the ErrorLog directive of httpd.conf
 * 1)          filename given in the ErrorLog directive of httpd.conf

error    = error.log


 * 1) vhost -  This is where Logmonster learns about your Apache vhosts. If
 * 2)          you list them in your httpd.conf, then this should be set to
 * 3)          the full path of your httpd.conf file.
 * 4)              vhost = /usr/local/etc/apache/httpd.conf
 * 5)          If you use a include directory for your vhosts, then this
 * 6)          should be the full path to that directory.
 * 7)              vhost = /usr/local/etc/apache/vhosts
 * 8) vhost    = /etc/httpd/vhosts              # darwin
 * 9) vhost    = /var/www/vhosts                # linux
 * 10) vhost    = /usr/local/etc/apache/Includes # freebsd
 * 1)              vhost = /usr/local/etc/apache/vhosts
 * 2) vhost    = /etc/httpd/vhosts              # darwin
 * 3) vhost    = /var/www/vhosts                # linux
 * 4) vhost    = /usr/local/etc/apache/Includes # freebsd
 * 1) vhost    = /usr/local/etc/apache/Includes # freebsd

vhost    = /usr/local/etc/lighttpd.conf


 * 1) processor - Which log file processor to feed the logs through. Currently,
 * 2)             webalizer, http-analzye, and awstats are supported.
 * 3)             This is the default processor and can be overridden for each
 * 4)             virtualhost/domain by placing a .processor file in the stats
 * 5)             dir. The files first line must be the name of the
 * 6)             processor: awstats, http-analyze, or webalizer.
 * 1)             dir. The files first line must be the name of the
 * 2)             processor: awstats, http-analyze, or webalizer.

processor = awstats


 * 1) hosts  - a space delimited list of the hostname(s) of your web servers.
 * 2)          Logmonster will retrieve the log files from each server. In order
 * 3)          to retrieve logs from remote servers, you must make sure ssh key
 * 4)          based authentication is set up between the machine you are
 * 5)          running logmonster on and your log/web servers.
 * 6) hosts    = localhost lab.simerson.net seattle.simerson.net
 * 1) hosts    = localhost lab.simerson.net seattle.simerson.net
 * 1) hosts    = localhost lab.simerson.net seattle.simerson.net

hosts    = localhost


 * 1) Countlog - is a binary value, 0 = off, 1 = on. If enabled, logmonster will
 * 2)            Write hit counts to a count file in the same directory as your
 * 3)            Apache logs. This feature integrates nicely with RRDUtil to
 * 4)            graph web hits for domains over extended periods of time.
 * 5)              See http://www.tnpi.biz/internet/manage/rrdutil/
 * 1)              See http://www.tnpi.biz/internet/manage/rrdutil/
 * 1)              See http://www.tnpi.biz/internet/manage/rrdutil/

CountLog = 1


 * 1) clean - Logmonster creates a bunch of scratch files in tmpdir while it's
 * 2)         working. If you set clean to 0 (default = 1) then it'll leave the
 * 3)         temp files behind. This is useful when I'm debugging, and you
 * 4)         might find it useful as well.
 * 1)         might find it useful as well.

clean = 1