Drop-in replacement for Python's built-in `logging` module
Project description
loggingx.py
loggingx
is a drop-in replacement for Python's built-in logging
module. Even better, once you've imported loggingx
, you don't need to modify your existing logging
module.
python3 -m pip install loggingx-py
Additional Format
Attribute name | Format | Description |
---|---|---|
caller | %(caller)s | Caller(<pathname>:<lineno> ) |
ctxFields | %(ctxFields)s | Context fields |
Optimization
Configuration | Description |
---|---|
logging.logThreads |
If False , Record will not collect thread and threadName . |
logging.logProcesses |
If False , Record will not collect process . |
logging.logMultiprocessing |
If False , Record will not collect processName . |
Context
import loggingx as logging
handler = logging.StreamHandler()
handler.setFormatter(logging.ConsoleFormatter())
logging.basicConfig(level=logging.INFO, handlers=[handler])
def A() -> None:
logging.info("A")
with logging.addFields(A="a"):
B()
def B() -> None:
logging.info("B")
with logging.addFields(B="b"):
C()
def C() -> None:
logging.info("C")
if __name__ == "__main__":
A()
2024-08-22T02:46:38.257+09:00 INFO main.py:9 A {}
2024-08-22T02:46:38.257+09:00 INFO main.py:15 B {"A": "a"}
2024-08-22T02:46:38.258+09:00 INFO main.py:21 C {"A": "a", "B": "b"}
Formatter
JSONFormatter
import loggingx as logging
handler = logging.StreamHandler()
# handler.setFormatter(logging.JSONFormatter())
handler.setFormatter(logging.JSONFormatter(logging.Information.THREAD_NAME))
logging.basicConfig(level=logging.INFO, handlers=[handler])
if __name__ == "__main__":
with logging.addFields(ctx="ctx"):
logging.info("test", extra={"extra": "extra"})
{
"time": 1689697694.9980711,
"level": "info",
"caller": "main.py:10",
"msg": "test",
"ctx": "ctx",
"thread_name": "MainThread",
"extra": "extra"
}
ConsoleFormatter
import loggingx as logging
handler = logging.StreamHandler()
handler.setFormatter(logging.ConsoleFormatter())
logging.basicConfig(level=logging.INFO, handlers=[handler])
if __name__ == "__main__":
with logging.addFields(ctx="ctx"):
logging.info("test", extra={"extra": "extra"})
2024-08-22T02:48:17.868+09:00 INFO main.py:9 test {"ctx": "ctx", "extra": "extra"}
With logging
import logging
import loggingx
# handler = loggingx.StreamHandler()
handler = logging.StreamHandler()
handler.setFormatter(loggingx.JSONFormatter())
# loggingx.basicConfig(level=loggingx.INFO, handlers=[handler])
logging.basicConfig(level=logging.INFO, handlers=[handler])
if __name__ == "__main__":
with loggingx.addFields(ctx="ctx"):
# loggingx.info("test", extra={"extra": "extra"})
logging.info("test", extra={"extra": "extra"})
orjson
If orjson
is installed, this module will use orjson
instead of json
.
jq
alias log2jq="jq -rRC --unbuffered '. as \$line | try fromjson catch \$line' | sed 's/\\\\n/\\n/g; s/\\\\t/\\t/g'"
python3 <path> 2>&1 | log2jq
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
loggingx_py-0.11.0.tar.gz
(17.1 kB
view hashes)
Built Distribution
Close
Hashes for loggingx_py-0.11.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | deaeb55264f927ff085faa684ce649a2525710a217cfa956dbd53f3a97f160f2 |
|
MD5 | f08a9a57fe1997b872bea7c7a4544244 |
|
BLAKE2b-256 | 4e734ffe2ed4090113ca26c8540af4a8d75beaa6bd03e1f9f4f2eab8c47a0abd |