docs(logging): document structured logs workspace

- add roadmap note for the new CCS logging surface

- record logging architecture and codebase ownership

- add logging standards for bounded, redacted runtime logs

Refs #926
This commit is contained in:
Tam Nhu Tran
2026-04-08 15:57:14 -04:00
parent 87c781a6a2
commit 548edda58b
4 changed files with 29 additions and 3 deletions
+9 -1
View File
@@ -1,6 +1,6 @@
# CCS Code Standards
Last Updated: 2026-02-04
Last Updated: 2026-04-07
Code standards, modularization patterns, and conventions for the CCS codebase.
@@ -383,6 +383,14 @@ export type {
## Terminal Output Standards
### CCS Logging Standards
- Use the shared logger from `src/services/logging/` for CCS-owned runtime diagnostics, request tracing, and structured events.
- Keep `utils/ui` and deliberate `console.log`/`console.error` output for user-facing CLI UX only.
- Redact secrets before persistence; never write raw tokens, cookies, API keys, or password hashes into CCS-owned logs.
- Persist CCS-owned logs only under `getCcsDir()/logs`; do not invent per-feature log roots.
- When adding dashboard polling or diagnostics routes, prevent them from recursively logging the log viewer itself.
### ASCII Only
```typescript