Skip to main content

A small Python library that provides a sane log output format

Project description

 _    ___   ___ ___ _  _   _
| |  / _ \ / __/ __| \| | /_\
| |_| (_) | (_ \__ \ .` |/ _ \
|____\___/ \___|___/_|\_/_/ \_\

logsna is a small Python library that provides a sane log output format.

http://logsna.readthedocs.org

Installation

$ [sudo] pip install logsna

Or the bleeding edge version from the git master branch:

$ [sudo] pip install git+https://github.com/rspivak/logsna.git#egg=logsna

How to use it

logsna provides a custom formatter class logsna.Formatter that can be used in a logging config file:

# sanefmt.py
import logging
import logging.config
from StringIO import StringIO

CONFIG = """\
[loggers]
keys=root

[handlers]
keys=console

[handler_console]
class=logging.StreamHandler
args=(sys.stderr,)
formatter=sane

[formatters]
keys=sane

[logger_root]
level=DEBUG
handlers=console

# Our custom formatter class
[formatter_sane]
class=logsna.Formatter
"""

config = StringIO(CONFIG)
logging.config.fileConfig(config)

log = logging.getLogger('mylogger.component1')

log.debug('debug message')
log.info('info message')
log.warning('warning message')
log.critical('critical message')
try:
    1 / 0
except:
    log.exception('Houston we have a problem')

This is how to use it in code directly:

import logging

import logsna

# create logger
log = logging.getLogger('mylogger.component1')
log.setLevel(logging.DEBUG)

# create console handler and set level to debug
ch = logging.StreamHandler()
ch.setLevel(logging.DEBUG)

# create an instance of the sane formatter
formatter = logsna.Formatter()

# add our formatter to the console handler
ch.setFormatter(formatter)

# add the console handler to the logger
log.addHandler(ch)

log.debug('debug message')
log.info('info message')
log.warning('warning message')
log.critical('critical message')
try:
    1 / 0
except:
    log.exception('Houston we have a problem')

The Log Format

Here is an output from the above program:

DEBUG    [2012-05-21 01:59:23,686] mylogger.component1: debug message
INFO     [2012-05-21 01:59:23,686] mylogger.component1: info message
WARNING  [2012-05-21 01:59:23,686] mylogger.component1: warning message
CRITICAL [2012-05-21 01:59:23,686] mylogger.component1: critical message
ERROR    [2012-05-21 01:59:23,686] mylogger.component1: Houston we have a problem
! Traceback (most recent call last):
!   File "/home/alienoid/python/sanefmt.py", line 67, in <module>
!     1 / 0
! ZeroDivisionError: integer division or modulo by zero

The Log Format Goals

  1. To be human readable as much as possible
  2. Make it easy to use with standard Unix utilities tail and grep to help quickly figure out why things are going south

The Log Format Notes

  1. All timestamps are in ISO8601 and UTC format

  2. To grep for messages of a specific level

    $ tail -f sanefmt.log | grep '^INFO'
    
  3. To grep for messages from a particular logger

    $ tail -f sanefmt.log | grep 'component1:'
    
  4. To pull out full exception tracebacks with a corresponding log message

    $ tail -f sanefmt.log | grep -B 1 '^\!'
    

    The output of the above command will look like this

    ERROR    [2012-05-21 01:59:23,686] mylogger.component1: Houston we have a problem
    ! Traceback (most recent call last):
    !   File "fmttest.py", line 72, in <module>
    !     1 / 0
    ! ZeroDivisionError: integer division or modulo by zero
    

Enhancing The Log Format Output

Here is the format string used by Logsna formatter:

'%(levelname)-8s [%(asctime)s] %(name)s: %(message)s'

You can explicitly specify it in your configuration file using format directive

# Our custom formatter class
[formatter_sane]
format=%(levelname)-8s [%(asctime)s] %(name)s: %(message)s
class=logsna.Formatter

And you can also enhance the format string by adding your custom attributes to it if you need to. For a set of predefined log record attributes see here

Acknowledgments

License

Copyright (c) 2012 Ruslan Spivak

Published under The MIT License, see LICENSE

Change History

1.2 (2012-10-02)

  • Python 2.6.x compatibility

1.1 (2012-05-21)

1.0 (2012-05-21)

  • Public release

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
logsna-1.2.zip (10.2 kB) Copy SHA256 hash SHA256 Source None Oct 2, 2012

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page