Skip to main content

A Python logging handler that buffers DEBUG/INFO and flushes them only when WARNING or ERROR fires

Project description

EmergencyLogging

A Python logging handler that stays silent during normal operation and only writes logs when something goes wrong.

The problem

Verbose debug logging helps diagnose issues, but writing every DEBUG and INFO message to a file or console creates noise that obscures what matters. The usual workaround — raising the log level to WARNING — means you lose the context that would have explained why the warning happened.

How it works

EmergencyHandler wraps any standard logging.Handler. It buffers DEBUG and INFO records silently. The moment a WARNING, ERROR, or CRITICAL is emitted, it flushes the buffered context followed by the triggering message — then clears the buffer and starts over.

Normal operation:        DEBUG INFO DEBUG INFO DEBUG INFO  →  (nothing written)
Something goes wrong:    DEBUG INFO DEBUG INFO ERROR       →  DEBUG INFO DEBUG INFO ERROR

The buffer holds the most recent N records (default 30). Older records are dropped as new ones arrive, so the buffer always contains the last N lines of context leading up to the problem.

Installation

Via pip (recommended)

pip install emergency-logging

Manual

No dependencies outside the standard library. Copy emergency_logging.py directly into your project.

Requires Python 3.8+.

Usage

Basic — wrap the default stderr handler

import logging
from emergency_logging import EmergencyHandler

logger = logging.getLogger("myapp")
logger.setLevel(logging.DEBUG)
logger.addHandler(EmergencyHandler())

logger.debug("connecting to database")   # buffered
logger.info("query executed in 4 ms")    # buffered
logger.error("connection pool exhausted") # flushes both lines above, then this

With a custom handler and buffer size

import logging
from emergency_logging import EmergencyHandler

stream = logging.StreamHandler()
stream.setFormatter(logging.Formatter("%(levelname)s %(name)s: %(message)s"))

logger = logging.getLogger("myapp")
logger.setLevel(logging.DEBUG)
logger.addHandler(EmergencyHandler(target_handler=stream, buffer_size=50))

With RotatingFileHandler

The log file stays empty during normal operation and only grows when an incident occurs — keeping file sizes minimal while preserving full diagnostic context when you need it.

import logging
from logging.handlers import RotatingFileHandler
from emergency_logging import EmergencyHandler

rotating = RotatingFileHandler("app.log", maxBytes=1024 * 1024, backupCount=5)
rotating.setFormatter(logging.Formatter("%(asctime)s %(levelname)-8s %(name)s: %(message)s"))

logger = logging.getLogger("myapp")
logger.setLevel(logging.DEBUG)
logger.addHandler(EmergencyHandler(target_handler=rotating, buffer_size=30))

API

EmergencyHandler(target_handler=None, buffer_size=30)

Parameter Type Default Description
target_handler logging.Handler StreamHandler() The handler that receives flushed records
buffer_size int 30 Maximum number of DEBUG/INFO records to buffer; oldest are dropped when exceeded

The handler passes through WARNING, ERROR, and CRITICAL records immediately (after flushing the buffer). DEBUG and INFO records are only ever written as part of a flush.

Comparison to MemoryHandler

Python's standard library includes logging.handlers.MemoryHandler, which is the closest built-in equivalent. Here's how they differ:

MemoryHandler EmergencyHandler
Flush trigger ERROR (default) or buffer full WARNING (default)
Buffer full behaviour Flushes the entire buffer immediately Drops the oldest record, keeps the newest N
After a flush Buffer cleared Buffer cleared
Most recent context guaranteed No — a busy logger flushes everything on capacity Yes — you always get the last N lines before the incident

The practical difference: MemoryHandler doesn't miss anything in the log. EmergencyHandler behaves like a ring buffer — it silently discards unimportant records that are too old to matter and always preserves the most recent context window.

Running the demos

python3 demo.py

Running the tests

python3 -m unittest test_emergency_logging -v

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

emergency_logging-0.1.1.tar.gz (4.0 kB view details)

Uploaded Source

Built Distribution

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

emergency_logging-0.1.1-py3-none-any.whl (4.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: emergency_logging-0.1.1.tar.gz
  • Upload date:
  • Size: 4.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for emergency_logging-0.1.1.tar.gz
Algorithm Hash digest
SHA256 ccf480558e49ad255a7031eb352c1cce740ea1ba32b8abf5dcd3dee1a6df3083
MD5 1dfe873abaab5f0dfa90a96dfdd1d422
BLAKE2b-256 8fd8baf5bdd2be322addd7c6daf796bc0ed21335356188eafc5f53a7b2302e1f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for emergency_logging-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f79b48d35b29a1fbe846e82ff5916ee2dd4daa524eb764baabbdfbaa1025c773
MD5 b97e41433f2b2457a1e1ce276c3d082b
BLAKE2b-256 46e05ef37ead9dda60be87ea65d4b91650750963f8fbc46ffeffbd718a436cbb

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