Skip to main content

Logging Extensions

Project description

Implements a few extensions for the standard python logging library.

Currently, this project lacks documentation. Sorry about that.

Logging Context Filter

Logging Context Filter injects context variables into LogRecord objects as extra fields.

Here’s a usage example:

import logging
import sys

from loggingex.context import LoggingContextFilter, context

log = logging.getLogger()

def process_lines(lines):
    for index, line in enumerate(lines):
        line = line.strip()
        with context(current_line=index + 1):
            log.debug("processing line: %s", line)
            if not line:
                log.error("empty line!")
  "processed line: %s", line)

def process_files(filenames):
    for filename in filenames:
        with context(current_file=filename):
  "processing file: %s", filename)
            with open(filename, "r") as f:
  "processed file: %s", filename)
    log.debug("work is complete!")

if __name__ == "__main__":
    formatter = logging.Formatter(
        "%(current_file)s:%(current_line)s:%(levelname)s: %(message)s"
    handler = logging.StreamHandler(stream=sys.stdout)
    handler.addFilter(LoggingContextFilter())  # it's that simple
    logging.basicConfig(handlers=[handler], level=logging.DEBUG)

    with context(current_file="-", current_line="-"):
        # The context above sets default value, so that the formatter does
        # not crash, when they are not defined.

Project details

Download files

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

Source Distribution

loggingex-1.2.0.tar.gz (20.8 kB view hashes)

Uploaded source

Built Distribution

loggingex-1.2.0-py3-none-any.whl (11.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page