Skip to content

Commit efbf300

Browse files
committed
docs(spec): correct the tracing entry's lit control and name the released package version
Two corrections from the in-seat contract review of PR #18016. The ADR-0087 entry's lit control said 20875 Schema occurrences on a corpus it described as the tree excluding `packages/spec` AND the generated reference pages. 20875 is the count with `content/docs/references` still in; the corpus the sentence names reads 18920. Both numbers now come from one `git grep -o` over `98bd7986fe` carrying both pathspec exclusions, and the sentence names that corpus exactly. The four tombstone prescriptions said `@objectstack/spec 18`. That conflates two axes: the prose names the released PACKAGE version, which is 17 (this ships in 17.5.0), while `RETIRED_KEYS_BY_MAJOR[18]` names the PROTOCOL major. A reader told "18" would look in a v18 that does not carry it. The tree spells it 17 in 265 places against 14, and this file's own `Span.duration` precedent says 17. `registry.ts` and the reference page are regenerated, not edited. Claude-Session: https://claude.ai/code/session_015c5G6TmpMKgnusmTpD7Ntt Co-authored-by: Claude <noreply@anthropic.com>
1 parent 37f29a4 commit efbf300

4 files changed

Lines changed: 14 additions & 12 deletions

File tree

‎content/docs/references/system/tracing.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ OpenTelemetry compatibility configuration
5353
| **protocol** | `string` | optional | Protocol version |
5454
| **headers** | `Record<string, string>` | optional | HTTP headers |
5555
| **timeoutMs** | `integer` | optional (default: `10000`) | Exporter request timeout in milliseconds |
56-
| **timeout** | `never` | optional | [REMOVED] `OpenTelemetryCompatibility.exporter.timeout` was renamed to `timeoutMs` in @objectstack/spec 18 — the unit of a duration-shaped number lives in the key name, not only in the describe prose. Its unit (milliseconds) lived in a source JSDoc only and the key carried no describe at all, so the reference-page reader got a bare 10000 and could not tell it from 10000 seconds. Rename the key to `timeoutMs`; the value (milliseconds) and the 10000 default are unchanged. |
56+
| **timeout** | `never` | optional | [REMOVED] `OpenTelemetryCompatibility.exporter.timeout` was renamed to `timeoutMs` in @objectstack/spec 17 — the unit of a duration-shaped number lives in the key name, not only in the describe prose. Its unit (milliseconds) lived in a source JSDoc only and the key carried no describe at all, so the reference-page reader got a bare 10000 and could not tell it from 10000 seconds. Rename the key to `timeoutMs`; the value (milliseconds) and the 10000 default are unchanged. |
5757
| **compression** | `Enum<'none' \| 'gzip'>` | optional (default: `"none"`) | |
5858
| **batch** | `{ maxBatchSize: integer; maxQueueSize: integer; exportTimeoutMs: integer; scheduledDelayMs: integer }` | optional | |
5959

@@ -498,7 +498,7 @@ Tracing configuration
498498
| :--- | :--- | :--- | :--- |
499499
| **asyncExport** | `boolean` | optional (default: `true`) | |
500500
| **exportIntervalMs** | `integer` | optional (default: `5000`) | Background span-export interval in milliseconds |
501-
| **exportInterval** | `never` | optional | [REMOVED] `TracingConfig.performance.exportInterval` was renamed to `exportIntervalMs` in @objectstack/spec 18 — the unit of a duration-shaped number lives in the key name, not only in the describe prose. Its unit (milliseconds) lived in a source JSDoc only and the key carried no describe at all, so the reference-page reader got a bare 5000. Rename the key to `exportIntervalMs`; the value (milliseconds) and the 5000 default are unchanged. |
501+
| **exportInterval** | `never` | optional | [REMOVED] `TracingConfig.performance.exportInterval` was renamed to `exportIntervalMs` in @objectstack/spec 17 — the unit of a duration-shaped number lives in the key name, not only in the describe prose. Its unit (milliseconds) lived in a source JSDoc only and the key carried no describe at all, so the reference-page reader got a bare 5000. Rename the key to `exportIntervalMs`; the value (milliseconds) and the 5000 default are unchanged. |
502502

503503

504504
---

‎packages/spec/src/migrations/entries/semantic/18.system-tracing-otel-exporter-durations-unit-in-key.ts‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -57,9 +57,10 @@ export const entry: SemanticMigration = {
5757
+ 'system-tracing-span-duration-unit-in-key recorded for the other key on this file. '
5858
+ 'Measured at 98bd7986fe: NO in-repo reader exists outside packages/spec — '
5959
+ 'OpenTelemetryCompatibility, TracingConfig and all three batch key names occur 0 times '
60-
+ 'across the whole tree at that ref excluding packages/spec and the generated reference '
61-
+ 'pages, against a lit control of 20875 Schema occurrences on that same corpus and ref '
62-
+ 'and a dark control of 0; inside packages/spec the '
60+
+ 'across the whole tree at that ref excluding packages/spec and content/docs/references, '
61+
+ 'against a lit control of 18920 Schema occurrences on exactly that corpus and ref — both '
62+
+ 'counts from one git grep -o over 98bd7986fe with those two pathspec exclusions — and a '
63+
+ 'dark control of 0; inside packages/spec the '
6364
+ 'only occurrences are tracing.zod.ts, its test, and the generated rows in '
6465
+ 'content/docs/references/system/tracing.mdx, which this rename regenerates. And the '
6566
+ 'pinned objectui checkout — `.objectui-sha` = `53ded82bf7a494f54e344e19099dbf00854b8694` — names none of it: all 37 exports of '

‎packages/spec/src/migrations/registry.ts‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10599,9 +10599,10 @@ const step18: MigrationStep = {
1059910599
+ 'system-tracing-span-duration-unit-in-key recorded for the other key on this file. '
1060010600
+ 'Measured at 98bd7986fe: NO in-repo reader exists outside packages/spec — '
1060110601
+ 'OpenTelemetryCompatibility, TracingConfig and all three batch key names occur 0 times '
10602-
+ 'across the whole tree at that ref excluding packages/spec and the generated reference '
10603-
+ 'pages, against a lit control of 20875 Schema occurrences on that same corpus and ref '
10604-
+ 'and a dark control of 0; inside packages/spec the '
10602+
+ 'across the whole tree at that ref excluding packages/spec and content/docs/references, '
10603+
+ 'against a lit control of 18920 Schema occurrences on exactly that corpus and ref — both '
10604+
+ 'counts from one git grep -o over 98bd7986fe with those two pathspec exclusions — and a '
10605+
+ 'dark control of 0; inside packages/spec the '
1060510606
+ 'only occurrences are tracing.zod.ts, its test, and the generated rows in '
1060610607
+ 'content/docs/references/system/tracing.mdx, which this rename regenerates. And the '
1060710608
+ 'pinned objectui checkout — `.objectui-sha` = `53ded82bf7a494f54e344e19099dbf00854b8694` — names none of it: all 37 exports of '

‎packages/spec/src/system/tracing.zod.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -549,7 +549,7 @@ export const OpenTelemetryCompatibilitySchema = lazySchema(() => z.object({
549549
/** Tombstone for the rename above (#17785, ruling A on #15939). */
550550
timeout: retiredKey(
551551
'`OpenTelemetryCompatibility.exporter.timeout` was renamed to `timeoutMs` in '
552-
+ '@objectstack/spec 18 — the unit of a duration-shaped number lives in the key name, '
552+
+ '@objectstack/spec 17 — the unit of a duration-shaped number lives in the key name, '
553553
+ 'not only in the describe prose. Its unit (milliseconds) lived in a source JSDoc '
554554
+ 'only and the key carried no describe at all, so the reference-page reader got a '
555555
+ 'bare 10000 and could not tell it from 10000 seconds. Rename the key to `timeoutMs`; '
@@ -600,15 +600,15 @@ export const OpenTelemetryCompatibilitySchema = lazySchema(() => z.object({
600600
/** Tombstones for the two renames above (#17785, ruling A on #15939). */
601601
exportTimeout: retiredKey(
602602
'`OpenTelemetryCompatibility.exporter.batch.exportTimeout` was renamed to '
603-
+ '`exportTimeoutMs` in @objectstack/spec 18 — the unit of a duration-shaped number '
603+
+ '`exportTimeoutMs` in @objectstack/spec 17 — the unit of a duration-shaped number '
604604
+ 'lives in the key name, not only in the describe prose. Its unit (milliseconds) '
605605
+ 'lived in a source JSDoc only and the key carried no describe at all, so the '
606606
+ 'reference-page reader got a bare 30000. Rename the key to `exportTimeoutMs`; the '
607607
+ 'value (milliseconds) and the 30000 default are unchanged.',
608608
),
609609
scheduledDelay: retiredKey(
610610
'`OpenTelemetryCompatibility.exporter.batch.scheduledDelay` was renamed to '
611-
+ '`scheduledDelayMs` in @objectstack/spec 18 — the unit of a duration-shaped number '
611+
+ '`scheduledDelayMs` in @objectstack/spec 17 — the unit of a duration-shaped number '
612612
+ 'lives in the key name, not only in the describe prose. Its unit (milliseconds) '
613613
+ 'lived in a source JSDoc only and the key carried no describe at all, so the '
614614
+ 'reference-page reader got a bare 5000. Rename the key to `scheduledDelayMs`; the '
@@ -777,7 +777,7 @@ export const TracingConfigSchema = lazySchema(() => z.object({
777777
/** Tombstone for the rename above (#17785, ruling A on #15939). */
778778
exportInterval: retiredKey(
779779
'`TracingConfig.performance.exportInterval` was renamed to `exportIntervalMs` in '
780-
+ '@objectstack/spec 18 — the unit of a duration-shaped number lives in the key name, '
780+
+ '@objectstack/spec 17 — the unit of a duration-shaped number lives in the key name, '
781781
+ 'not only in the describe prose. Its unit (milliseconds) lived in a source JSDoc '
782782
+ 'only and the key carried no describe at all, so the reference-page reader got a '
783783
+ 'bare 5000. Rename the key to `exportIntervalMs`; the value (milliseconds) and the '

0 commit comments

Comments
 (0)