apache-log2

Apache/CLF access logging for Nodejs

Author: Raimar Falke

Licence: GNU GENERAL PUBLIC LICENSE Version 3

Dependencies: sprintf

Based on: the work of Robert Edward Steckroth II [email protected] aka Surgemcgee / Bustout

Description:

Outputs NodeJs request/response event logs with a Apache/CLF format. Supports common and combined log formats. Licensed under the GNU v3.

Features:

• Automatic Content-length computations
• Activated when a response.end is called
• Does not require middleware, e.g. express or connect
• Defaults to Apache2 log formatting defaults
• Does not require a call to writeHead to output with CLF conformity

Changes compared to apache-log:

• Correct content length calculation when multiple write() calls occur
• Also support Buffers in addition of strings as arguments to write() and end()
• Replace apache_log.data.settings() call with apache_log.configure with different signature
• Allow to set the path before the first write operation. No more accesses to /var/log/access.log.

Caveats:

• Will not compute time zone information. Many clf analyzers use geoip given this is a common problem.

example output line of combined log
127.0.0.1 - - [10/Aug/2013:22:18:19 +0000] "GET /?f=sabl1vpghojkc8dre7j1n&s=+yhoo+goog HTTP/1.1" 200 687 "-" "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Ubuntu Chromium/28.0.1500.71 Chrome/28.0.1500.71 Safari/537.36"

Usage:

    var apache_log = require('apache-log2')
    http.createServer(function(req, res) {
      apache_log.logger(req, res)
      res.writeHead(200, {'Content-Type': 'text/html'} )
      res.end('This is when the logger will output to the specified log file.') 
    }).listen(8080)

Settings:

The default file is "/var/log/access.log" and the format is "combined". Call apache_log.configure() with the filename (including the directory) and the format ('common' or 'combined') to change these values.

    var apache_log = require('apache-log2')

    apache_log.configure("/var/http/logs/access.log", "common");

    http.createServer(function(req, res) {
      apache_log.logger(req, res)
      res.writeHead(200, {'Content-Type': 'text/html'} )
      res.end('This is when the logger will output to the specified log file.')
    }).listen(8080)