🪵 Logging & Debug

Good exception handling is only half the battle — logging is what keeps your team sane in production.

With APIException, unexpected errors don’t just return a nice JSON response;

they’re also automatically logged so you always have a clear trail of what went wrong.

---

✅ How It Works

When you use:

from APIException import register_exception_handlers
from fastapi import FastAPI

app = FastAPI()
register_exception_handlers(
    app=app,
    use_fallback_middleware=True
)

You get two powerful behaviors:

1️⃣ All handled APIExceptions are logged with: - HTTP status - Exception code - Message - Context & traceback

2️⃣ Unhandled exceptions (like DB errors, 3rd-party failures) are caught by the fallback middleware and: - Return a consistent JSON error response (ISE-500 by default) - The full traceback to your console or logging system

---

⚙️ Example Output

When something unexpected happens, you’ll see logs like:

---

⚡ Tips

✅ Use FastAPI’s native logging module to pipe logs to your file, console, or external log aggregator (ELK, CloudWatch, etc.).

✅ Combine this with FastAPI middlewares or your own log formatter if you want structured JSON logs.

✅ For sensitive environments, make sure your logs do not expose user data.

---

📚 Next

✔️ Want to see how fallback works?
Check out 🪓 Fallback Middleware

✔️ Need better Swagger docs?
Go to 📚 Swagger Integration

✔️ Haven’t defined custom codes yet?
Read 🗂️ Custom Exception Codes