Skip to content

Latest commit

 

History

History
65 lines (40 loc) · 2.36 KB

README.md

File metadata and controls

65 lines (40 loc) · 2.36 KB
Raw

logreporter

Getting emails with every single occurrence of an error is a bit of a pain .

LogReporter is a simple script that scans a list of log files looking for specific types of messages. Currently this involves looking for messages that are logged in a specific format and for specific tags.

Once the logs have been checked, the script will then email a report of the found errors (if any) to a list of recipients as a plain text email.

This package also contains a script specifically for watching the output of varnishlog for 503 errors .

Installation

git clone git://github.com/<username>/logreporter.git
cd logreporter
virtualenv .
. bin/activate
python setup.py develop

Running the scripts

Varnish Watch

varnish-watch is used to watch the output of varnishlog for 503 errors. When the data is piped into varnish-watch new records will be written to STDOUT in an apache format (so that it can then be reported on with the logreports).

It is expected that the complete command line will be something like

varnishlog -o | \
  perl -ne 'BEGIN { $/ = "";} print if (/TxStatus.*(50\d)/);'  | \
  varnish-watch > varnish-503.log

LogReports

Rather than have a config file (for the moment) the script it managed by a collection of command line arguments that specify what is expected of the script.

The arguments accepted by the script are:

  • --logs - A comma separated list of log files to check
  • --sender - email address for the sender (defaults to root@{servername})
  • --recipients - A comma separated list of people to receive the email.
  • --server - the host:ip of the smtp server if it is not localhost:25
  • --hours - The number of hours in the past (from right now) to look back in the log file.

An example command line might be:

LOGROOT=/var/log/ckan
src/logreporter.py --logs $LOGROOT"/ckan.log" \
    --server localhost:1025 \
    --recipients ross@localhost.local \
    --hours 2400

In the example above, the SMTP server is set to localhost:1025 for testing and you can set up a test email server by using:

python -m smtpd -n -c DebuggingServer localhost:1025

TODO

  • Group errors together with a count of how many times, and over what time period they occurred.
  • Accept more than one logging level
  • Provide a way of specifying how to match a log entry.