tiered_debug documentation

tiered-debug is a Python module for tiered debug logging at levels 1-5, with configurable stack levels for accurate caller reporting and extra metadata for enhanced log context. It is designed for projects requiring detailed debugging, such as Elasticsearch workflows.

The module provides a TieredDebug class for logging, and the debug.py module offers a global TieredDebug instance and a begin_end decorator to log function entry and exit at customizable debug levels.

Contents:

• Installation
  • Requirements
  • Install tiered-debug
  • Configuration
• Usage
  • Using TieredDebug Directly
  • Using debug.py for Project-Wide Debugging
  • Elasticsearch Logging
  • Testing with pytest
• The sample debug.py module
• API Reference
  • Modules
• Contributing
  • Getting Started
  • Submitting Changes
  • Code Style
  • Documentation
  • Issues and Feedback
• Changelog
  • [1.4.0] - 2025-10-07
  • [1.3.1] - 2025-10-03
  • [1.3.0] - 2025-04-21
  • [1.2.1] - 2025-04-17
  • [1.2.0] - 2025-04-17
  • [1.1.0] - 2025-04-15
  • [1.0.0] - 2025-03-31

Indices and tables

• Index

• Module Index

• Search Page