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-pyAdditional 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
logging.basicConfig(
level=logging.INFO,
format="%(asctime)s\t%(levelname)s\t%(caller)s\t%(message)s\t%(ctxFields)s",
)
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()2023-07-19 01:15:33,981 INFO loggingx.py/main.py:10 A {}
2023-07-19 01:15:33,981 INFO loggingx.py/main.py:16 B {'A': 'a'}
2023-07-19 01:15:33,982 INFO loggingx.py/main.py:22 C {'A': 'a', 'B': 'b'}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": "loggingx.py/main.py:10",
"msg": "test",
"ctx": "ctx",
"thread_name": "MainThread",
"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"})jq
alias log2jq="jq -R -r '. as \$line | try fromjson catch \$line'"python3 <path> 2>&1 | log2jq
