tegwick
0b7eeb1483
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Assistant: claude-code Assistant-Model: opus Assistant-Process: 3775@bnt-lap001 Assistant-Session: cfacb6a5-ad5b-4f79-ac67-053e3b0d34a3
76 lines
4.2 KiB
Markdown
76 lines
4.2 KiB
Markdown
# OrwellLoggingDiagnostics — candidate practice pattern
|
|
|
|
Candidate ID: `practice-pattern/orwell-logging-diagnostics`
|
|
Canonical owner: info-tech-canon
|
|
Requested by: coordination-engine / COORDINATION-WP-0003-T04
|
|
Follow-up: COORDINATION-WP-0004
|
|
Known use: tmux-amq's local diagnostic mode
|
|
Status: superseded by canon. Registered by info-tech-canon as
|
|
`practice-pattern/explicit-unsafe-diagnostic-mode`
|
|
(`infospace/patterns/ExplicitUnsafeDiagnosticMode.md`, pattern status
|
|
`candidate`, version 0.1) at canon version 0.13.0 under INFO-WP-0030
|
|
|
|
## Problem
|
|
|
|
Normal operational logs must omit message bodies, credentials, and unrestricted
|
|
terminal output. Rare local debugging sessions may need otherwise omitted
|
|
fields to explain a transport failure. A diagnostic override must never quietly
|
|
become the production logging policy.
|
|
|
|
## Proposed practice
|
|
|
|
1. Safe logging is the default at every verbosity. Increasing verbosity alone
|
|
must not disclose sensitive fields.
|
|
2. An explicit per-invocation `--orwell` option selects the unsafe diagnostic
|
|
mode. Configuration files, inherited profile defaults and background startup
|
|
must not enable it silently.
|
|
3. Refuse the option in the production policy. Emit a prominent warning before
|
|
collecting any additional fields in an explicitly non-production session.
|
|
4. Write only to an owner-controlled local mode-0600 sink. Never send those fields
|
|
to State Hub, central telemetry, message exports, or shared CI artifacts.
|
|
5. Document precisely which fields can be captured. Prefer synthetic data for
|
|
reproduction. The operator selects the shortest useful capture and removes
|
|
the unsafe log after diagnosis using the storage owner's procedure.
|
|
6. Verify default omission, per-invocation opt-in, production rejection, file
|
|
permissions, and separation from remote projection in the consumer tests.
|
|
|
|
## Consumer boundary
|
|
|
|
TAMQ owns its diagnostic flag and sensitive transport fields. Coordination-engine
|
|
only emits sanitized transition receipts, has no unsafe logging flag, and never
|
|
projects checkpoint contents. Introducing an unsafe runtime sink is unnecessary
|
|
for WP-0003's worker coordination behavior.
|
|
|
|
## Canon review handoff
|
|
|
|
The owner should compare this candidate with existing observability and data
|
|
handling practices, decide whether to observe/map/adapt/adopt/reject it, and
|
|
register the accepted artifact through its assimilation process. The canonical
|
|
`infospace/assimilation/intake-and-assimilation-practice.md` requires an explicit
|
|
owner disposition before a canon change; a candidate is not registration.
|
|
|
|
2026-09-07: the operator approved transferring canon review/registration from
|
|
WP-0003-T04 to `workplans/COORDINATION-WP-0004-orwell-canon-review.md`. The
|
|
follow-up requires explicit owner disposition and, if accepted, a canonical
|
|
artifact/version/index entry. WP-0003 closure does not imply canonical acceptance.
|
|
|
|
2026-09-24: info-tech-canon disposed this candidate as **adapt** under
|
|
`INFO-DEC-2026-003`; its assimilation record is
|
|
`infospace/assimilation/orwell-logging-diagnostics/ASSIMILATION.md` (commit
|
|
`5a1ea90`), which freezes this file at `628f984` under `source/`. No changes to
|
|
this candidate were requested. The canon form will take a neutral name and the
|
|
`PracticePatternScheme` layout; the six practice points carry over unchanged.
|
|
Canon placement is pending under `INFO-WP-0030`, so there is still no
|
|
registered canonical artifact and this file remains a candidate, not canon.
|
|
The disposition does not authorize unsafe logging in any runtime.
|
|
|
|
2026-10-03: registration complete. info-tech-canon finished `INFO-WP-0030` on
|
|
2026-09-27 and returned the registration in State Hub message `37bf8ae5`:
|
|
artifact `practice-pattern/explicit-unsafe-diagnostic-mode`, path
|
|
`infospace/patterns/ExplicitUnsafeDiagnosticMode.md`, pattern status
|
|
`candidate`, version 0.1, canon version 0.13.0. Verified in the owner checkout:
|
|
the pattern file exists with that id and version, and
|
|
`infospace/artifacts/index.yaml` lists it. The owner reports `make check`
|
|
passing (60 tests, 0 validation errors or warnings). The canonical name is
|
|
neutral; `OrwellLoggingDiagnostics` is kept as an alias. This file is now a
|
|
historical candidate. Cite the canonical artifact, not this file.
|