oc_diagnostics Documentation

Contents:

• oc_diagnostics
  • Installation
  • Quickstart
  • Features
  • Documentation
  • License
• oc_diagnostics Architecture Document
  • Table of Contents
• 1. Overview
• 2. High-Level Architecture
• 3. Directory Structure
• 4. Core Components
  • 4.1 unified_debug.py
  • 4.2 id_instrumentation.py
  • 4.3 instrumentation_middleware.py
  • 4.4 ui_event_logger.py
  • 4.5 Self-Test Suite
  • 4.6 fastapi_middleware.py
  • 4.7 logging_handler.py
• 5. Diagnostics Configuration
• 6. Import Surface
• 7. Lifecycle & Integration
• 8. Future Enhancements
• 9. Appendix: Mindmap Overview
• oc_diagnostics — Unified Debugging & Instrumentation System
  • Table of Contents
  • Overview
  • Unified Debugging System
  • Instrumentation System
  • Instrumentation Middleware
  • UI Event Logger
  • FastAPI / ASGI Middleware
  • Self‑Test Suite
  • Migration Tool
  • Recommended Debug Configurations
  • Extending the System
  • Appendix: File Map
• Option‑C Diagnostics Integration Guide
• Table of Contents
• 1. File Header & Module Structure
• 2. _dbg Usage
• 3. Debug Levels
• 4. Debug Domains
• 5. Function Style & Diagnostics Pattern
• 6. Docstring & Commenting Style
• 7. Imports & Layout
• 8. Applying Option‑C to New Files
• 9. Full Diagnostics System
• 10. FastAPI Integration
  • Installation
  • Setup
  • Enable HTTP logging
  • What gets logged
  • Contracts
• 11. UI Event Logger Integration
  • Required prerequisite — dcc.Store
  • Setup
  • Log output
  • Value truncation
  • Enable UI logging
• 12. Config Hot-Reload
  • Activation
  • What gets updated
  • Notes
• 13. Production Mode
  • Via environment variable
  • Via debug_config.json
  • Effect
  • Combining with explicit arguments
• 14. Async Usage
  • Import
  • Usage
  • Usage in FastAPI endpoints
  • Key behaviors
• 15. Python logging Integration
  • Setup
  • Default level mapping
  • Custom level mapping
  • Notes
• 16. Log Rotation
  • Count-based rotation
  • Size-based rotation
  • Combined configuration
  • Notes

API Reference:

• API Reference
  • oc_diagnostics package
    • oc_diagnostics
    • DiagnosticsMiddleware
    • OcDiagnosticsHandler
    • apply_instrumentation()
    • dbg_metrics()
    • dbg_profile()
    • dbg_scope()
    • dbg_timed()
    • dbg_trace()
    • init()
    • set_debug_level()
    • set_global_setting()
    • Submodules