logging module: add client_addr to all log records

[Joel.Hedlund]

Hi!

I'm writing a server and I want to use the logging module for logging
stuff. I want to log all transactions in detail, and if everything goes
haywire I want to know which client did it. Therefore I want to affix
the client address to every single log item.

I would like to do the following:
Formatter("[%(client_addr)s]: %(message)s")
....
logger.critical ("Offal Barrage Detected: Running Away", client_addr =
'french.knights .org')

I've written something that accomplishes this (example below), but I
have this nagging feeling that this could have been done in a better
way. Any ideas?

When test.py executes it prints this:
[WARNING|2006-05-08 23:44:57,421|in ternal]: Unable to Pronounce 'ni!'
[WARNING|2006-05-08 23:44:57,421|fr ench.knights.nu]: Incoming Bovine
Detected

I'm grateful for any advice.

Cheers!
/Joel Hedlund

test.py
---------------------------------------------------------------------
import logging
import cowlogger
logger = logging.getLogg er('cowlogger')
logger.warning( "Unable to Pronounce 'ni!'")
logger.warning( "Incoming Bovine Detected",
client_addr = 'french.knights .nu')
---------------------------------------------------------------------

cowlogger.py
---------------------------------------------------------------------
import logging

BaseLogger = logging.getLogg erClass()

class LogRecord(loggi ng.LogRecord):
def __init__(self, name, level, pathname, lineno, msg, args,
exc_info, client_addr):
"""
Adding client_addr as instantiation parameter and
attribute.
"""
logging.LogReco rd.__init__(sel f, name, level, pathname,
lineno, msg, args, exc_info)
self.client_add r = client_addr

class CowLogger(BaseL ogger):
def makeRecord(self , name, level, fn, lno, msg, args, exc_info,
client_addr):
"""
Code nicked from logging.Logger. I just added client_addr
to header and LogRecord instantiation.
"""
return LogRecord(name, level, fn, lno, msg, args, exc_info,
client_addr)

def _log(self, level, msg, args, exc_info=None,
client_addr = 'internal'):
"""
Code nicked from logging.Logger. I just added client_addr
to header and makeRecord call.
"""
if logging._srcfil e:
fn, lno, func = self.findCaller ()
else:
fn, lno, func = "(unknown file)", 0, "(unknown function)"
if exc_info:
if type(exc_info) != types.TupleType :
exc_info = sys.exc_info()
record = self.makeRecord (self.name, level, fn, lno, msg,
args, exc_info, client_addr)
self.handle(rec ord)

logging.setLogg erClass(CowLogg er)

# Setting up log item formatting:
format = "[%(levelname)s|% (asctime)s|%(cl ient_addr)s]: %(message)s"
formatter = logging.Formatt er(format)
handler = logging.StreamH andler()
handler.setForm atter(formatter )
logger = logging.getLogg er('cowlogger')
logger.addHandl er(handler)
---------------------------------------------------------------------

[Joel Hedlund]

> See a very similar example which uses the new 'extra' keyword argument:

Now that's brilliant! Exactly what I need.

But unfortunately, it's also unavailable until 2.5 comes out. Until then I'm
afraid I'm stuck with my shoddy hack... but it's always nice to know the time
will come when I can finally throw it out!

Thanks for taking the time!

Cheers!
/Joel