Skip to main content

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

Project description

philiprehberger-json-logger

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.0.tar.gz (4.8 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.0-py3-none-any.whl (4.2 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for philiprehberger_json_logger-0.1.0.tar.gz
Algorithm Hash digest
SHA256 25c0597cff276d0a0ee27cba6c8f412dfcdd3f2ef571575fea6ef7033ce370ad
MD5 6567dac407c88f1663d239122bfb3718
BLAKE2b-256 e3b2cef1c9a225950098d052895afd04a9264590db6217d8c41c38293770e84f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_json_logger-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 79e168e44ebb16d54006625fad85de0dc5ad9824eaa079e5fe36f7b8d00aa668
MD5 e9c76489b3fbc16e170eaa91a61e269b
BLAKE2b-256 1034921d37a889dee132e6686e649144649bab612a67cf2e200a9a99be40adc4

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