Skip to content

Commit 4fb58b3

Browse files
Merge pull request #91 from engineeredsoftware/v35/gate-3-telemetry-taxonomy-event-schema-redaction
V35 Gate 3: Telemetry Taxonomy Event Schema And Redaction
2 parents 3167892 + d4f007a commit 4fb58b3

17 files changed

Lines changed: 2419 additions & 13 deletions

.bitcode/v35-telemetry-taxonomy-catalog.json

Lines changed: 1336 additions & 0 deletions
Large diffs are not rendered by default.

.github/workflows/bitcode-gate-quality.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,6 +167,9 @@ jobs:
167167
if [ -f scripts/check-v35-gate2-documentation-surface-catalog.mjs ]; then
168168
node scripts/check-v35-gate2-documentation-surface-catalog.mjs --skip-branch-check
169169
fi
170+
if [ -f scripts/check-v35-gate3-telemetry-taxonomy-event-schema-redaction.mjs ]; then
171+
node scripts/check-v35-gate3-telemetry-taxonomy-event-schema-redaction.mjs --skip-branch-check
172+
fi
170173
fi
171174
node scripts/check-v34-gate10-promotion-readiness.mjs --promotion-mode --skip-branch-check
172175
else
@@ -215,6 +218,7 @@ jobs:
215218
pnpm --filter @bitcode/btd test -- --runTestsByPath __tests__/v32-testnet-mainnet-readiness-rehearsal.test.ts
216219
pnpm --dir packages/protocol exec node --test --test-force-exit test/v32-promotion-proof-generation.test.js
217220
pnpm --dir packages/protocol exec node --test --test-force-exit test/v35-documentation-surface-catalog.test.js
221+
pnpm --dir packages/protocol exec node --test --test-force-exit test/v35-telemetry-taxonomy-catalog.test.js
218222
pnpm --filter @bitcode/api exec jest --config jest.config.cjs --runTestsByPath src/routes/__tests__/btd-crypto.test.ts --runInBand
219223
pnpm --filter @bitcode/api exec jest --config jest.config.cjs --runTestsByPath src/routes/__tests__/auxillaries-contract.test.ts --runInBand
220224
pnpm --dir packages/executions-mcp/src/mcp-server run test:mcp -- --runTestsByPath src/__tests__/unit/auth.test.ts --runInBand

BITCODE_SPEC_V35.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- Current canonical/latest target: `V34`
88
- Prior canonical anchor: `BITCODE_SPEC_V34.md`
99
- Prior generated proof appendix: `BITCODE_SPEC_V34_PROVEN.md`
10-
- Generated structured artifact inventory: draft `.bitcode/v35-spec-family-report.json`, draft `.bitcode/v35-canonical-input-report.json`, source-safe `.bitcode/v35-documentation-surface-catalog.json`, future source-safe V35 telemetry/documentation artifacts, and `BITCODE_SPEC_V35_PROVEN.md` only after V35 promotion
10+
- Generated structured artifact inventory: draft `.bitcode/v35-spec-family-report.json`, draft `.bitcode/v35-canonical-input-report.json`, source-safe `.bitcode/v35-documentation-surface-catalog.json`, source-safe `.bitcode/v35-telemetry-taxonomy-catalog.json`, future source-safe V35 telemetry/documentation artifacts, and `BITCODE_SPEC_V35_PROVEN.md` only after V35 promotion
1111
- Source parity state: V35 source parity opens with Gate 1 and will close telemetry taxonomy, documentation surface, dashboard/runbook, documentation QA, onboarding, integration, rehearsal, and promotion-readiness gates before canonical promotion
1212
- Active canonical pointer during draft opening: `BITCODE_SPEC.txt` -> `V34`
1313
- Notes companion: `BITCODE_SPEC_V35_NOTES.md`
@@ -234,6 +234,34 @@ Every row names audience, owner, disclosure class, source roots, linked spec sec
234234
The catalog fails closed on missing source roots, stale source roots, `_legacy/` source roots, secret-shaped values, unsupported public disclosure, protected source, wallet private material, provider tokens, raw protected prompts, and unpaid AssetPack source.
235235
The artifact is generated by `pnpm run generate:v35-documentation-surface-catalog`, checked by `pnpm run check:v35-documentation-surface-catalog`, closed by `pnpm run check:v35-gate2`, and exported by `@bitcode/protocol` through `buildDocumentationSurfaceCatalog`.
236236

237+
## V35 TelemetryTaxonomyCatalog canon
238+
239+
Gate 3 materializes `TelemetryTaxonomyCatalog` as package-owned protocol truth.
240+
The deterministic artifact `.bitcode/v35-telemetry-taxonomy-catalog.json` carries `source-safe-telemetry-taxonomy-metadata` and proves fourteen required event-family rows:
241+
242+
- `pipeline`
243+
- `execution`
244+
- `ptrr_agent`
245+
- `thricified_generation`
246+
- `tool`
247+
- `ledger`
248+
- `wallet`
249+
- `storage`
250+
- `interface`
251+
- `deployment`
252+
- `observer`
253+
- `repair`
254+
- `docs_qa`
255+
- `promotion`
256+
257+
Every row names event ids, source surface, lifecycle stage, severity, source-safety class, redaction posture, correlation ids, proof root fields, storage target, dashboard panel, alert threshold, runbook link, source roots, replay expectation, and deterministic row root.
258+
Pipeline, PTRR agent, and ThricifiedGeneration rows preserve the formal abstraction vocabulary: executions are base runtime records, pipelines compose phases, agents are PTRR agents, PTRR steps remain the four formal steps, sub-steps are ThricifiedGenerations, tools are registry-backed calls, and prompts remain prompt-part and prompt-template registry compositions.
259+
Telemetry payloads are source-safe metadata only.
260+
They may carry event ids, correlation ids, proof roots, counts, state enums, policy ids, dashboard panel ids, and runbook ids.
261+
They must not carry secret values, service key values, provider tokens, wallet private material, raw protected prompts, raw model responses with protected source, protected source payloads, or unpaid AssetPack source.
262+
The catalog fails closed on missing event families, missing source roots, missing runbook links, missing dashboard panels, missing proof root fields, missing redaction posture, missing correlation ids, secret-shaped markers, protected source disclosure, wallet private material disclosure, raw protected prompts, and unpaid AssetPack source disclosure.
263+
The artifact is generated by `pnpm run generate:v35-telemetry-taxonomy-catalog`, checked by `pnpm run check:v35-telemetry-taxonomy-catalog`, closed by `pnpm run check:v35-gate3`, and exported by `@bitcode/protocol` through `buildTelemetryTaxonomyCatalog`.
264+
237265
## V35 whole Bitcode operator chain
238266

239267
The V35 operator chain keeps V34 behavior and adds source-safe documentation and telemetry visibility:

BITCODE_SPEC_V35_DELTA.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- Current canonical/latest target: `V34`
88
- Prior canonical anchor: `BITCODE_SPEC_V34.md`
99
- Prior generated proof appendix: `BITCODE_SPEC_V34_PROVEN.md`
10-
- Generated structured artifact inventory: draft `.bitcode/v35-spec-family-report.json`, draft `.bitcode/v35-canonical-input-report.json`, source-safe `.bitcode/v35-documentation-surface-catalog.json`, future source-safe V35 telemetry/documentation artifacts, and `BITCODE_SPEC_V35_PROVEN.md` only after V35 promotion
10+
- Generated structured artifact inventory: draft `.bitcode/v35-spec-family-report.json`, draft `.bitcode/v35-canonical-input-report.json`, source-safe `.bitcode/v35-documentation-surface-catalog.json`, source-safe `.bitcode/v35-telemetry-taxonomy-catalog.json`, future source-safe V35 telemetry/documentation artifacts, and `BITCODE_SPEC_V35_PROVEN.md` only after V35 promotion
1111
- Source parity state: V35 opens source parity for telemetry taxonomy, documentation surfaces, dashboard/runbook, documentation QA, onboarding, integration, rehearsal, and promotion-readiness gates
1212
- Spec companion: `BITCODE_SPEC_V35.md`
1313
- Notes companion: `BITCODE_SPEC_V35_NOTES.md`
@@ -99,6 +99,15 @@ Closure acceptance:
9999
- every event names redaction posture, source-safety class, correlation ids, proof root, storage target, dashboard panel, alert threshold, and runbook link;
100100
- event payloads fail closed on secrets, protected source, raw unpaid AssetPack source, and wallet private material.
101101

102+
Gate 3 closure implementation:
103+
104+
- `@bitcode/protocol` exports `TelemetryTaxonomyCatalog` support through `buildTelemetryTaxonomyCatalog`;
105+
- `.bitcode/v35-telemetry-taxonomy-catalog.json` records fourteen source-safe telemetry rows under `source-safe-telemetry-taxonomy-metadata`;
106+
- the catalog covers pipeline, execution, PTRR agent, ThricifiedGeneration, tool, ledger, wallet, storage, interface, deployment, observer, repair, docs QA, and promotion event families;
107+
- every row binds redaction posture, source-safety class, correlation ids, proof root fields, storage target, dashboard panel, alert threshold, runbook link, source roots, replay expectation, forbidden payload classes, and deterministic row root;
108+
- `pnpm run check:v35-telemetry-taxonomy-catalog` verifies artifact freshness, source roots, event-family coverage, and source-safe redaction posture;
109+
- `pnpm run check:v35-gate3` verifies package source, generated artifact, package tests, workflows, docs, parity, roadmap advancement, and generated artifact profile binding.
110+
102111
### Gate 4: Public Docs Usage Guides
103112

104113
Gate 4 makes enterprise-facing docs a maintained product surface.

BITCODE_SPEC_V35_NOTES.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- Current canonical/latest target: `V34`
88
- Prior canonical anchor: `BITCODE_SPEC_V34.md`
99
- Prior generated proof appendix: `BITCODE_SPEC_V34_PROVEN.md`
10-
- Generated structured artifact inventory: draft `.bitcode/v35-spec-family-report.json`, draft `.bitcode/v35-canonical-input-report.json`, source-safe `.bitcode/v35-documentation-surface-catalog.json`, future source-safe V35 telemetry/documentation artifacts, and `BITCODE_SPEC_V35_PROVEN.md` only after V35 promotion
10+
- Generated structured artifact inventory: draft `.bitcode/v35-spec-family-report.json`, draft `.bitcode/v35-canonical-input-report.json`, source-safe `.bitcode/v35-documentation-surface-catalog.json`, source-safe `.bitcode/v35-telemetry-taxonomy-catalog.json`, future source-safe V35 telemetry/documentation artifacts, and `BITCODE_SPEC_V35_PROVEN.md` only after V35 promotion
1111
- Source parity state: V35 opens source parity for telemetry taxonomy, documentation surfaces, dashboard/runbook, documentation QA, onboarding, integration, rehearsal, and promotion-readiness gates
1212
- Scope: V35 draft notes for telemetry and documentation depth over promoted V34 deployment canon
1313
- Last fully realized canonical target preserved in source: `V34`
@@ -57,6 +57,7 @@ Read the system as:
5757
- `TestnetRolloutReadinessGuide` carries contributor, operator, enterprise reader, depositor, and interface consumer paths for local and staging-testnet use.
5858
- V35 public docs can expose measurements, proof posture, fee/right boundaries, setup steps, and known blockers; they cannot expose secrets, wallet private material, protected source, raw prompts containing protected data, or unpaid AssetPack source.
5959
- Gate 2 closes `DocumentationSurfaceCatalog` with `.bitcode/v35-documentation-surface-catalog.json`, `source-safe-documentation-surface-metadata`, package export `buildDocumentationSurfaceCatalog`, package test coverage, and `check:v35-gate2`.
60+
- Gate 3 closes `TelemetryTaxonomyCatalog` with `.bitcode/v35-telemetry-taxonomy-catalog.json`, `source-safe-telemetry-taxonomy-metadata`, package export `buildTelemetryTaxonomyCatalog`, package test coverage, redaction posture for every event family, ThricifiedGeneration inference telemetry boundaries, and `check:v35-gate3`.
6061

6162
## Inherited deployment-depth notes
6263

BITCODE_SPEC_V35_PARITY_MATRIX.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
- Current canonical/latest target: `V34`
88
- Prior canonical anchor: `BITCODE_SPEC_V34.md`
99
- Prior generated proof appendix: `BITCODE_SPEC_V34_PROVEN.md`
10-
- Generated structured artifact inventory: draft `.bitcode/v35-spec-family-report.json`, draft `.bitcode/v35-canonical-input-report.json`, source-safe `.bitcode/v35-documentation-surface-catalog.json`, future source-safe V35 telemetry/documentation artifacts, and `BITCODE_SPEC_V35_PROVEN.md` only after V35 promotion
10+
- Generated structured artifact inventory: draft `.bitcode/v35-spec-family-report.json`, draft `.bitcode/v35-canonical-input-report.json`, source-safe `.bitcode/v35-documentation-surface-catalog.json`, source-safe `.bitcode/v35-telemetry-taxonomy-catalog.json`, future source-safe V35 telemetry/documentation artifacts, and `BITCODE_SPEC_V35_PROVEN.md` only after V35 promotion
1111
- Source parity state: V35 opens source parity for telemetry taxonomy, documentation surfaces, dashboard/runbook, documentation QA, onboarding, integration, rehearsal, and promotion-readiness gates
1212
- Spec companion: `BITCODE_SPEC_V35.md`
1313
- Notes companion: `BITCODE_SPEC_V35_NOTES.md`
@@ -55,7 +55,7 @@ No `_legacy/` source is active source truth.
5555
| Draft family and branch posture | Gate 1 | `BITCODE_SPEC_V35.md`, DELTA, NOTES, PARITY, `BITCODE_SPEC.txt`, branch `v35/gate-1-telemetry-docs-roadmap-opening` | drafted | V35 family validates in draft mode over active V34 and `check:v35-gate1` passes. |
5656
| Roadmap truth | Gate 1 | `SPECIFICATIONS_ROADMAP.md`, README, PR template, workflow posture | drafted | Roadmap states V34 active, V35 draft, and coherent V36-V37 responsibilities. |
5757
| Documentation surface catalog | Gate 2 | `DocumentationSurfaceCatalog`, `.bitcode/v35-documentation-surface-catalog.json`, `packages/protocol/src/canonical/documentation-surface-catalog.js`, `packages/protocol/test/v35-documentation-surface-catalog.test.js`, and `check:v35-gate2` | closed | Internal codebase docs, public `/docs`, package docs, route docs, generated artifact docs, API/interface docs, owners, freshness checks, and disclosure classes have package-owned rows. |
58-
| Telemetry taxonomy event schema | Gate 3 | `TelemetryTaxonomyCatalog`, generated telemetry taxonomy artifact, tests, and `check:v35-gate3` | drafted | Pipeline, execution, PTRR agent, ThricifiedGeneration, tool, ledger, wallet, storage, interface, deployment, observer, repair, docs QA, and promotion events are source-safe and proof-rooted. |
58+
| Telemetry taxonomy event schema | Gate 3 | `TelemetryTaxonomyCatalog`, `.bitcode/v35-telemetry-taxonomy-catalog.json`, `packages/protocol/src/canonical/telemetry-taxonomy-catalog.js`, `packages/protocol/test/v35-telemetry-taxonomy-catalog.test.js`, and `check:v35-gate3` | closed | Pipeline, execution, PTRR agent, ThricifiedGeneration, tool, ledger, wallet, storage, interface, deployment, observer, repair, docs QA, and promotion events are source-safe and proof-rooted. |
5959
| Public docs usage guides | Gate 4 | public `/docs`, internal docs roots, package docs, source-safe examples, and `check:v35-gate4` | drafted | Terminal, Protocol, Auxillaries, MCP API, ChatGPT App, BTD, AssetPack ranges, Reads, fees, and proof posture docs derive from package/SPEC truth. |
6060
| Dashboards alerts runbooks incident escalation | Gate 5 | `OperatorRunbookCatalog`, dashboard/runbook bindings, incident fixtures, and `check:v35-gate5` | drafted | Telemetry events bind to dashboard panels, alert thresholds, incident classes, escalation paths, safe commands, forbidden data, and post-incident docs updates. |
6161
| Documentation QA alignment proofs | Gate 6 | `DocsQaAlignmentReport`, generated alignment artifact, tests, workflows, and `check:v35-gate6` | drafted | Code, SPEC, DELTA, NOTES, PARITY, generated proofs, generated artifacts, public docs, internal docs, route docs, and interface docs fail closed on drift. |
@@ -73,6 +73,7 @@ No `_legacy/` source is active source truth.
7373
| Spec-family shape | V35 SPEC, DELTA, NOTES, and PARITY satisfy the full spec-family checker | drafted |
7474
| Gate 1 script | `pnpm run check:v35-gate1` fails closed on stale posture, missing roadmap truth, or missing telemetry/documentation scope | drafted |
7575
| Gate 2 script | `pnpm run check:v35-gate2` fails closed on stale documentation surface catalog, missing source roots, source-unsafe disclosure, missing package export, missing package test, missing workflow wiring, or missing generated artifact profile binding | closed |
76+
| Gate 3 script | `pnpm run check:v35-gate3` fails closed on stale telemetry taxonomy catalog, missing event families, missing redaction posture, missing proof roots, missing source roots, source-unsafe telemetry payloads, missing package export, missing package test, missing workflow wiring, or missing generated artifact profile binding | closed |
7677
| Gate-quality workflow | Gate workflow validates V34 active / V35 draft posture and the V35 Gate 1 checker | drafted |
7778
| Canon-quality workflow | Canon workflow validates promoted V34 canon, V35 draft family when present, and V34/V35 posture | drafted |
7879
| Package docs | README, protocol package README, demonstration README, and PR template state V34 active / V35 draft workflow | drafted |
@@ -112,9 +113,13 @@ No `_legacy/` source is active source truth.
112113

113114
| Requirement | Source evidence | Current V35 judgment |
114115
| --- | --- | --- |
115-
| Telemetry taxonomy planned | `TelemetryTaxonomyCatalog` in SPEC/DELTA/NOTES/PARITY | drafted |
116-
| Pipeline and inference event families named | V35 SPEC and notes | drafted |
117-
| Redaction posture planned | V35 Gate 3 acceptance criteria | drafted |
116+
| Telemetry taxonomy implemented | `packages/protocol/src/canonical/telemetry-taxonomy-catalog.js` exports `buildTelemetryTaxonomyCatalog`, `TELEMETRY_EVENT_FAMILIES`, and telemetry rows | closed |
117+
| Generated artifact exists | `.bitcode/v35-telemetry-taxonomy-catalog.json` with `source-safe-telemetry-taxonomy-metadata` | closed |
118+
| Pipeline and inference event families named | Catalog rows include `pipeline`, `execution`, `ptrr_agent`, `thricified_generation`, and `tool` with formal abstraction names preserved | closed |
119+
| Runtime, value, storage, and interface event families named | Catalog rows include `ledger`, `wallet`, `storage`, `interface`, `deployment`, `observer`, and `repair` | closed |
120+
| Docs QA and promotion event families named | Catalog rows include `docs_qa` and `promotion` with dashboard, runbook, proof root, and replay expectations | closed |
121+
| Redaction posture enforced | Every row names redaction posture, forbidden payload classes, correlation ids, proof root fields, source roots, dashboard panel, alert threshold, runbook link, and deterministic row root | closed |
122+
| Gate 3 package and workflow proof | `packages/protocol/test/v35-telemetry-taxonomy-catalog.test.js`, `scripts/check-v35-gate3-telemetry-taxonomy-event-schema-redaction.mjs`, `package.json`, and `.github/workflows/bitcode-gate-quality.yml` | closed |
118123

119124
## Gate 4 Parity
120125

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ onboarding, operator guides, and testnet-rollout readiness.
2020
V35 Gate 2 now anchors documentation surfaces through the package-owned
2121
`DocumentationSurfaceCatalog` and the source-safe generated artifact
2222
`.bitcode/v35-documentation-surface-catalog.json`.
23+
V35 Gate 3 now anchors telemetry event families through the package-owned
24+
`TelemetryTaxonomyCatalog` and the source-safe generated artifact
25+
`.bitcode/v35-telemetry-taxonomy-catalog.json`.
2326

2427
The protocol demonstration remains the minimal deterministic reference for the
2528
same protocol. Commercial code may mount or compare against demonstration

0 commit comments

Comments
 (0)