debug-logging-assistant

Add debug logging statements to code without altering program behavior.

109|40|Updated Jul 24, 2017

Search Tags:#debugging #logging #safety #observability #instrumentation #code-quality #non-invasive

Ready to run

npx skills add https://github.com/dmitriiweb/extract-emails --skill debug-logging-assistant

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: debug-logging-assistant
Source: https://github.com/dmitriiweb/extract-emails/tree/main/.codex/skills/debug-logging-assistant
Command: npx skills add https://github.com/dmitriiweb/extract-emails --skill debug-logging-assistant

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

In production codebases, insufficient visibility into execution flow, inputs, and errors leads to longer debugging cycles and unreproducible failures.

Core Features & Use Cases

Non-invasive instrumentation that adds minimal logging statements without altering control flow.
Guidance aligned with existing logging conventions and safety constraints.
Use Case: quickly diagnose a failing endpoint by tracing request flow and key state changes.

Quick Start

Identify critical code paths, insert concise debug logs at entry and exit points, and verify that program behavior remains unchanged.

Frequently Asked Questions about debug-logging-assistant

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I add debug logging to improve observability without changing program behavior?▼

Non-invasive debug logging adds minimal logging statements to trace execution flow, inputs, and error paths without altering control flow or changing program behavior. It targets critical code paths at entry and exit points to improve observability safely.

What is non-invasive instrumentation for debugging production failures?▼

Non-invasive instrumentation is the practice of inserting concise debug logs into critical code paths to trace control flow and key state changes. It provides visibility into unreproducible failures and retries without modifying the underlying program logic.

How do I ensure safe logging that avoids leaking sensitive data in production code?▼

Safe logging adheres to established safety guidelines to avoid logging sensitive data. It aligns with existing logging conventions while adding targeted debug statements to trace request flow, ensuring observability does not compromise data security.

What is the best way to diagnose a failing endpoint by tracing request flow?▼

The best way to diagnose a failing endpoint is adding targeted debug logs at entry and exit points of critical code paths. This traces request flow and key state changes, quickly diagnosing failures while keeping program behavior unchanged.

Does this debug logging approach work with existing logging conventions in my codebase?▼

Yes, this instrumentation approach is designed to adhere to existing logging conventions and safety constraints. It integrates non-invasive debug logs into your codebase while satisfying established guidelines to avoid logging sensitive data.

When should I avoid adding debug logging to trace execution flow?▼

You should avoid adding debug logging when it risks altering control flow or violating safety constraints by logging sensitive data. If visibility into execution flow cannot be achieved non-invasively, alternative debugging methods are required.