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.2.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.2-py3-none-any.whl (4.3 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for philiprehberger_json_logger-0.1.2.tar.gz
Algorithm Hash digest
SHA256 38b78e1cbf06603175e748f280e2ee5679ffa7e536588227721ab51821bfa013
MD5 f23ea1e095f177d206743c9babb99d8b
BLAKE2b-256 80838005ebe692a922c7b32622ecfbc69d5bc14cd26ad8743fdf18b9ffa089bc

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for philiprehberger_json_logger-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 5fd80fbea6227be97b52481785ed7e3efa1339b35ded05abd351e8332856b221
MD5 3b9fb32cba1c8469af33765dce1c74e5
BLAKE2b-256 89c4f3ab620650dbbe149940c8e71f3420a1991181ece9147ab05eee010c25c4

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