Skip to main content

Belogging

Project description

Don’t fight with logging …

TravisCI Build Status Coverage Status PyPI Version PyPI License PyPI latest


Easy logging configuration based on environment variables.

Features:

  • Set logging level using environment variable LOG_LEVEL (defaults to ‘INFO’)
  • Set which loggers to enable using environment variable LOGGERS (defaults to ‘’, everything)
  • Always output to stdout
  • Optional JSON formatter
  • Completely disable logging setting LOG_LEVEL=DISABLED

Requirements:

  • Python 3.5 and beyond

Install:

pip install belogging

Examples:

Simple applications:

# my_script.py

import belogging
belogging.load()
# ^^ this call is optional, only useful for customization
# For example, to enable JSON output: belogging.load(json=True)

# belogging.getLogger is just a sugar to logging.getLogger, you can
# use logging.getLogger as usual (and recommended).
logger = belogging.getLogger('foobar')
logger.debug('test 1')
logger.info('test 2')

Executing:

# selecting LOG_LEVEL
$ LOG_LEVEL=DEBUG python my_script.py
# level=DEBUG message=test 1
# level=INFO message=test 2

# selecting LOGGERS
$ LOGGERS=foobar python my_script.py
# Both messages

# Both
$ LOGGERS=foobar LOG_LEVEL=INFO my_script.py
# only level=INFO message=test 2

Applications should call `belogging.load()` upon initialization. The first `__init__.py` would be a good candidate, but anything before any call to `logging` module will be fine.

Django:

In your projects `settings.py`:

import belogging
# Disable django logging setup
LOGGING_CONFIG = None
belogging.load()

Inside your code, just use `logging.getLogger()` as usual.

$ export LOG_LEVEL=WARNING
$ ./manage.py runserver
# It will output only logging messages with severity > WARNING

Logging follows a hierarchy, so you easily select or skip some logging messages:

$ export LOGGERS=my_app.critical_a,my_app.critical_c,my_lib
$ ./my-app.py
# "my_app.critical_b messages" will be skipped
# all messages from my_lib will show up

Changelog:

0.1.2

  • Add missing tests asserts
  • Add lock for dealing with OrderedDict self._cache

0.1.1

  • Workaround to prevent KeyError exception in LoggerDuplicationFilter

0.1.0

  • Add JSON formatter
  • Minor improvements

0.0.2

  • Added LoggerDuplicationFilter and enable_duplication_filter option
  • Added belogging.getLogger (sugar to logging.getLogger)

0.0.1

  • Initial release

Project details


Release history Release notifications

This version
History Node

0.1.2

History Node

0.1.1

History Node

0.1.0

History Node

0.0.2

History Node

0.0.1

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
belogging-0.1.2-py3-none-any.whl (7.9 kB) Copy SHA256 hash SHA256 Wheel py3 Oct 17, 2017
belogging-0.1.2.tar.gz (6.1 kB) Copy SHA256 hash SHA256 Source None Oct 17, 2017

Supported by

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