docs(002): re-baseline the telemetry spec for review round 2 of cdk-terrain #62 - #6
Open
so0k wants to merge 4 commits into
Open
docs(002): re-baseline the telemetry spec for review round 2 of cdk-terrain #62#6so0k wants to merge 4 commits into
so0k wants to merge 4 commits into
Conversation
Revises FR-005 (the typed CdktfConfig getter is gone; one forgiving reader in commons), FR-012 (the Errors factories count cli.error instead of posting) and FR-014 (the canonical metric list with its attribute sets), and adds FR-019 (binary and target attributes), FR-020 (the restored per-stack signal), FR-021 (attribute validation) and FR-022 (the single failure path, absorbing #378). Adds SC-009 and SC-010, re-grounds SC-001's evidence, and records the HCL-output provider gap.
…evaluation Adds the review round 2 note (decisions, privacy findings from the refutation rounds, test review verdicts, known gaps) and the asset pipeline telemetry evaluation, with pointers from research.md.
…tes to the code C1 gains the payload allow-list and the metric catalogue plus C1b for the Errors factories; C2 records the single commons reader; C5 becomes the one bounded flush helper and the single failure path; C6 lists what was removed. The data model carries the base attribute set, the metric table, the SDK-stamped fields and the current call-site map. Quickstart re-grounds journey 1's evidence, rewrites the bundle E2E journey around the CI step and adds the failure-path journey. The migration notes list what is collected and what is never sent.
6 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Re-baselines
specledger/002-remove-hashicorp-telemetryto the state of cdk-terrain PR #62 after its second review round (2026-09-09). The code is the source of truth; every metric name and attribute set below was derived frompackages/@cdktn/commons/src/telemetry.tsand its delivery-oracle tests.What changed
CdktfConfig.sendUsageTelemetrygetter was removed; exactly one forgiving reader in commons), FR-012 (theErrorsfactories countcli.error{type, command}instead of posting), FR-014 (the canonical metric table with per-metric attributes and the once-per-failed-run rule forcli.command.error), FR-003 note for the^10.73.0pin. New FR-019 (binary, target and platform attributes from one lazy process-global probe), FR-020 (the restored per-stack and per-binding signal), FR-021 (enumerated and validated attributes, typed per-command allow-list, identity caps, SDK-stamped fields limited), FR-022 (single failure path, synchronous.fail, metric before the one bounded flush; absorbs cdk-terrain #378, fixes #360 and #361). SC-001 evidence re-grounded on the delivery oracle plus the CI E2E; SC-009 (E2E on every build) and SC-010 (LEAK-marker refutation) added. The HCL-outputcli.stack.providergap recorded as an edge case.research.mdgets a pointer.Known divergences left as written
cli.command.erroris not literal: two synth paths exit the process themselves and count their own failure; the spec says "once per failed run", which is what the code guarantees.data-model.mdcarries the current count.