Commit 3092c47
committed
docs(codereview): add Logging Hygiene rule against object dumps in info logs
Codify the policy uncovered while toning down agent-server / SDK info
logs (PRs #3216, #3217). Reviewers should flag `logger.info(...)` calls
that interpolate `model_dump(...)`, `.json()`, `to_dict()`, lists,
dicts, or other unbounded values — those belong in `logger.debug(...)`.
Adds:
- A "Logging Hygiene" subsection under SDK Architecture Conventions
with concrete bad/good examples drawn from real cases in this repo.
- A "What to Check" bullet pointing at the new section.
Co-authored-by: openhands <openhands@all-hands.dev>1 parent 2e3fbc8 commit 3092c47
1 file changed
Lines changed: 7 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
130 | 130 | | |
131 | 131 | | |
132 | 132 | | |
| 133 | + | |
133 | 134 | | |
134 | 135 | | |
135 | 136 | | |
| |||
221 | 222 | | |
222 | 223 | | |
223 | 224 | | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
224 | 231 | | |
225 | 232 | | |
226 | 233 | | |
| |||
0 commit comments