temmings / apachelog

Apache log file parser written in Python

Apache Access Log Parser

Simple parser to turn an Apache access_log file (or any other file conforming to the Common Log Format) into a usable dictionary of values.

(forked from the apachelog project on Google Code, which began as a Python port of Peter Hickman's Apache::LogEntry Perl module)

Usage

Create the parser with the log format from your server's config file, then parse lines to get a dict corresponding to fields defined in the log format.

Example:

import apachelog, sys

# Format copied and pasted from Apache conf - use raw string + single quotes
format = r'%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"'

p = apachelog.parser(format)

for line in open('/var/apache/access.log'):
    try:
       data = p.parse(line)
    except:
       sys.stderr.write("Unable to parse %s" % line)

The return dictionary from the parse method depends on the input format. For the above example, the returned dictionary would look like;

{
'%>s': '200',
'%b': '2607',
'%h': '212.74.15.68',
'%l': '-',
'%r': 'GET /images/previous.png HTTP/1.1',
'%t': '[23/Jan/2004:11:36:20 +0000]',
'%u': '-',
'%{Referer}i': 'http://peterhi.dyndns.org/bandwidth/index.html',
'%{User-Agent}i': 'Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.2) Gecko/20021202'
}

...given an access log entry like (split across lines for formatting):

212.74.15.68 - - [23/Jan/2004:11:36:20 +0000] "GET /images/previous.png HTTP/1.1"
    200 2607 "http://peterhi.dyndns.org/bandwidth/index.html"
    "Mozilla/5.0 (X11; U; Linux i686; en-US; rv:1.2) Gecko/20021202"

You can also re-map the field names by subclassing (or re-pointing) the alias method.

Generally you should be able to copy and paste the format string from your configuration file, but remember to place it in a raw string using single-quotes, so that backslashes are handled correctly.

Installation

Just clone this repository and run python setup.py install and you'll be on your way!

Tests

This program includes built-in unit testing, available by just running the apachelog.py file with no arguments.

License

This project is licensed under the Artistic License.