Skip to main content

Drop-in structured JSON logging for Python using the stdlib logging module

Project description

philiprehberger-json-logger

Tests PyPI version License

Drop-in structured JSON logging for Python using the stdlib logging module.

Install

pip install philiprehberger-json-logger

Usage

Quick setup

from philiprehberger_json_logger import setup

setup(level="DEBUG")

import logging
logging.info("Server started", extra={"port": 8080})
# {"timestamp": "2026-03-13T12:00:00+00:00", "level": "INFO", "message": "Server started", "logger": "root", "module": "app", "line": 5, "port": 8080}

Named logger

import logging
from philiprehberger_json_logger import setup

logger = logging.getLogger("myapp")
setup(level="INFO", logger=logger)

logger.warning("Disk usage high", extra={"usage_pct": 91.3})

Static extra fields

from philiprehberger_json_logger import setup

setup(level="INFO", extra_fields={"service": "api", "env": "production"})

Every log entry will include "service": "api" and "env": "production".

Custom handler with JsonFormatter

import logging
from philiprehberger_json_logger import JsonFormatter

handler = logging.FileHandler("app.log")
handler.setFormatter(JsonFormatter(extra_fields={"service": "worker"}))

logger = logging.getLogger("worker")
logger.addHandler(handler)
logger.setLevel(logging.INFO)

API

Name Description
JsonFormatter(*, extra_fields=None) Logging formatter that outputs JSON lines. extra_fields is a dict of static fields merged into every entry.
setup(level="INFO", *, extra_fields=None, logger=None) Configure a logger with JSON output. Defaults to the root logger. Clears existing handlers.

JSON output fields

Field Description
timestamp ISO 8601 UTC timestamp
level Log level name (DEBUG, INFO, WARNING, ERROR, CRITICAL)
message Formatted log message
logger Logger name
module Source module name
line Source line number
exception Full traceback string (only present when logging an exception)

Any extra={} kwargs passed to the log call are merged into the top-level JSON object. Static extra_fields from the formatter are also merged.

License

MIT

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

philiprehberger_json_logger-0.1.1.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

philiprehberger_json_logger-0.1.1-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

Details for the file philiprehberger_json_logger-0.1.1.tar.gz.

File metadata

File hashes

Hashes for philiprehberger_json_logger-0.1.1.tar.gz
Algorithm Hash digest
SHA256 35cc0d056c9df37fa6f614214d80cee4b22e46a05cda5cd922f38b66c68e9b9a
MD5 04f718672649cae7170064068b2b8dda
BLAKE2b-256 f7fa70d2b1a92ff67e2ca225f61dda8a058889c7d00538d70abae5b60e28696d

See more details on using hashes here.

File details

Details for the file philiprehberger_json_logger-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for philiprehberger_json_logger-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3f739b82bd4cd22a240c1ed20da07262481709d89f8eb5d22fdf12e1e2cea423
MD5 f7da6a023a4d7230074354121239579d
BLAKE2b-256 89095d204017264fc0627dc2f245bf686a2d5ac440032e52be4478c5f1b25047

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page