Python logging utilities
Project description
logdog
Python package with logging
utilities
Requirements
- Python >= 3.10
Installation
pip install -U python-logdog
Usage
[!NOTE] These are only basic examples. More advanced ones can be found in the
examples/
directory
Message wrapper
Basic
import logging
from logdog import LogMessageWrapper
logging.basicConfig(level=logging.INFO)
logger = logging.getLogger("mylogger")
user_id = 1
some_value = "some string"
logger.info("user login", extra={"not": "included", "user": user_id, "value": some_value})
# output: INFO:mylogger:user login
log = LogMessageWrapper(logger)
log.info("user login", user=user_id, action="login", value=some_value)
# output: INFO:mylogger:user login user=1 action=login value="some string"
Custom format
logging.basicConfig(level=logging.INFO, format="%(asctime)s : %(levelname)-8s : %(message)s")
logger = logging.getLogger("mylogger")
log = LogMessageWrapper(logger, prefix=" : ")
log.info("user login", user=user_id, action="login", value=some_value)
# output: 2023-09-05 12:01:09,836 : INFO : user login : user=1 action=login value="some string"
Renderers
Currently there are 2 renderers:
LogfmtRenderer
(default one)JsonRenderer
Same simple example using different renderer:
from logdog.wrapper import JsonRenderer, LogMessageWrapper
logging.basicConfig(level=logging.INFO, format="%(asctime)s : %(levelname)-8s : %(message)s")
logger = logging.getLogger("mylogger")
log = LogMessageWrapper(
logger,
prefix=" [",
suffix="]",
renderer=JsonRenderer(),
)
log.info("user login", user=user_id, action="login", value=some_value)
# output: 2023-09-05 12:01:09,836 : INFO : user login [{"user": 1, "action": "login", "value": "some string"}]
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
python-logdog-0.1.2.tar.gz
(9.1 kB
view hashes)
Built Distribution
Close
Hashes for python_logdog-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6c20cd13feebca7fa2bc6d8c896dc900997acfefbb741579c0b34148474dcfff |
|
MD5 | 2197d90eaf603aeaec9848eaf255a13d |
|
BLAKE2b-256 | c41a2230a8c054b6bfbab0b46238fc925fac74718a605eae9f89f933f27d54a4 |