#$Id#

Log-Statistics
========================

*** WARNING ***

This is alpha quality code.  Documentation is limited.  some features
are only partially implemented.

Stay tuned for updates.

DESCRIPTION

Monitoring an application frequently involves monitoring it's log
file(s). Log files may contain hundreds or thousands of events per
minute. Parsing the entire log file can be a very cpu intensive task
making near-real-time reporting or monitoring difficult.

logstatsd was designed to solve this problem. logstatsd runs as a
daemon on the server where the log file resides, parsing new entries
as they enter the log, and storing statistics. The daemon can be
signaled to export current xml reports or to update an RRD.

Log::Statistics parses log entries into fields and collects statistics
about fields that you find interesting (e.g. date/time, duration,
transaction name, status, end user locations, etc). For example, if a
transaction field is specified, the number of hits for each unique
transaction will be tracked. If a duration field is available in the
log, then information about average response times of each transaction
will also be tracked.

For more information, see:

    http://www.geekfarm.org/wu/muse/LogStatistics.html

INSTALLATION

To install this module type the following:

   perl Makefile.PL
   make
   make test
   make install

DEPENDENCIES

Log::Statistics depends on these other modules and libraries:

   YAML
   Date::Manip

logstatsd depends on these modules and libraries:

   Benchmark
   File::Tail
   Config::IniFiles
   XML::Simple
   Getopt::Long
   Pod::Usage   
   Log::Log4perl - can be safely disabled by commenting out use Log::Log4perl lines

COPYRIGHT AND LICENCE

Copyright (c) 2006, VVu@geekfarm.org
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:

- Redistributions of source code must retain the above copyright
  notice, this list of conditions and the following disclaimer.

- Redistributions in binary form must reproduce the above copyright
  notice, this list of conditions and the following disclaimer in the
  documentation and/or other materials provided with the distribution.

- Neither the name of the geekfarm.org nor the names of its
  contributors may be used to endorse or promote products derived from
  this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
