https://github.com/georgeyk/belogging
Easy and opinionated logging configuration for Python apps
https://github.com/georgeyk/belogging
library logging python3
Last synced: 10 days ago
JSON representation
Easy and opinionated logging configuration for Python apps
- Host: GitHub
- URL: https://github.com/georgeyk/belogging
- Owner: georgeyk
- License: mit
- Created: 2016-09-03T01:41:21.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-12-18T20:02:38.000Z (5 months ago)
- Last Synced: 2025-04-25T19:55:01.678Z (16 days ago)
- Topics: library, logging, python3
- Language: Python
- Homepage:
- Size: 42 KB
- Stars: 22
- Watchers: 0
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGES.rst
- License: LICENSE
Awesome Lists containing this project
- starred-awesome - belogging - Easy and opinionated logging configuration for Python apps (Python)
README
Belogging
=========
*Don't fight with logging ...*
|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.10+
Install:
.. code-block:: bash
pip install belogging
Examples:
---------
Simple applications:
~~~~~~~~~~~~~~~~~~~~
.. code-block:: python
# 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:
.. code-block:: bash
# 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```:
.. code-block:: python
import belogging
# Disable django logging setup
LOGGING_CONFIG = None
belogging.load()
Inside your code, just use ```logging.getLogger()``` as usual.
.. code-block:: bash
$ 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:
.. code-block:: bash
$ 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
.. |Coverage Status| image:: https://coveralls.io/repos/github/georgeyk/belogging/badge.svg?branch=master
:target: https://coveralls.io/github/georgeyk/belogging?branch=master
.. |PyPI Version| image:: https://img.shields.io/pypi/pyversions/belogging.svg?maxAge=2592000
:target: https://pypi.python.org/pypi/belogging
.. |PyPI License| image:: https://img.shields.io/pypi/l/belogging.svg?maxAge=2592000
:target: https://pypi.python.org/pypi/belogging
.. |PyPI latest| image:: https://img.shields.io/pypi/v/belogging.svg?maxAge=2592000
:target: https://pypi.python.org/pypi/belogging