Skip to content

Standardize exception-logging conventions #437

Description

@ypldan

QuickApps version

latest

Area

Orchestrator / agent loop, Toolsets (REST / DIAL deployment / MCP / internal), Skills, Documentation

What is the current state?

Several exception-logging styles coexist: logger.exception(...) (the majority), logger.error(..., exc_info=True), and variants that drop the traceback or pass the exception object as the whole message. A few except: pass blocks log nothing. Message formatting is split between lazy %-style and f-strings, and deprecations are signaled through two different mechanisms.

Why is this debt?

Lost tracebacks and context-free messages slow down diagnosis, and without a written convention reviewers can't hold the line, so the drift continues.

Proposed remediation

One PR: add a "Logging" section to CODESTYLE.md (one blessed exception pattern — contextual message + traceback; no silent swallows without at least a DEBUG record; lazy %-style formatting), enable a lint rule for it in make lint, and mechanically fix the existing sites (roughly twenty across the codebase).

Alternatives considered

Convention-by-documentation without lint enforcement — the current spread happened under review; a lint gate is what holds it.

Additional information

Independent of the design gate (#434) — can run in parallel.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions