Skip to main content

Python logging library

Project description

Generic python logging library.

Documentation: https://github.com/SPSCommerce/spylogger

Installation

basic loggers

This installs spylogger only and will load the loggers with no external dependency requirements.

pip install spylogger

pretty loggers

This installs spylogger, pygments, and pygments-json and loads the basic loggers along with pretty loggers.

pip install spylogger[pretty]

Configuration

Environment Variables

Name

Description

Default

SPY_LOG_LOGGER

The configured logger name. Available loggers:

  • json-flat (Default)

  • json

  • json-src-key

  • pretty

  • ugly

json-flat

SPY_LOG_LEVEL

The python log level. See the docs

WARNING

SPY_SHOW_META

Flag for showing the __meta output.

True

SPY_JSON_LOG_KEYS

A list of log record keys to put in the __meta section of the log message.

Available Keys:

  • args

  • created

  • exc_info

  • exc_text

  • filename

  • funcName

  • levelname

  • levelno

  • lineno

  • module

  • msecs

  • msg

  • name

  • pathname

  • process

  • processName

  • relativeCreated

  • thread

  • threadName

See the python docs

  • args

  • funcName

  • levelname

  • lineno

  • module

  • pathname

  • process

  • threadName

Pretty Formatter Styles

See the pygments documentation

Environment Variables

Name

Default

SPY_LOG_FORMATTER_DEBUG

autumn

SPY_LOG_FORMATTER_INFO

monokai

SPY_LOG_FORMATTER_WARNING

fruity

SPY_LOG_FORMATTER_ERROR

default

SPY_LOG_FORMATTER_CRITICAL

vs

Available styles

  • algol

  • algol_nu

  • autumn

  • borland

  • bw

  • colorful

  • default

  • emacs

  • friendly

  • fruity

  • igor

  • lovelace

  • manni

  • monokai

  • murphy

  • native

  • paraiso-dark

  • paraiso-light

  • pastie

  • perldoc

  • rrt

  • tango

  • trac

  • vim

  • vs

  • xcode

Usage

from spylogger import get_logger

# get_logger(name=SPY_LOG_LOGGER, log_level=SPY_LOG_LEVEL)
logger = get_logger()

logger.info({'string': 'test Pretty info message.', 'int': 42, 'bool': True})

More examples are in example.py

Authors

See contributors section on GitHub.

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

spylogger-1.1.0.tar.gz (4.9 kB view hashes)

Uploaded Source

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