@decocms/blocks 8.16.1 → 8.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (112) hide show
  1. package/dist/v8/analytics/client.d.ts +48 -0
  2. package/dist/v8/analytics/client.d.ts.map +1 -0
  3. package/dist/v8/analytics/client.js +71 -0
  4. package/dist/v8/analytics/client.js.map +1 -0
  5. package/dist/v8/analytics/runtime/modules/click.d.ts +2 -0
  6. package/dist/v8/analytics/runtime/modules/click.d.ts.map +1 -0
  7. package/dist/v8/analytics/runtime/modules/click.js +48 -0
  8. package/dist/v8/analytics/runtime/modules/click.js.map +1 -0
  9. package/dist/v8/analytics/runtime/modules/commerce.d.ts +2 -0
  10. package/dist/v8/analytics/runtime/modules/commerce.d.ts.map +1 -0
  11. package/dist/v8/analytics/runtime/modules/commerce.js +41 -0
  12. package/dist/v8/analytics/runtime/modules/commerce.js.map +1 -0
  13. package/dist/v8/analytics/runtime/modules/consent.d.ts +33 -0
  14. package/dist/v8/analytics/runtime/modules/consent.d.ts.map +1 -0
  15. package/dist/v8/analytics/runtime/modules/consent.js +154 -0
  16. package/dist/v8/analytics/runtime/modules/consent.js.map +1 -0
  17. package/dist/v8/analytics/runtime/modules/deco.d.ts +2 -0
  18. package/dist/v8/analytics/runtime/modules/deco.d.ts.map +1 -0
  19. package/dist/v8/analytics/runtime/modules/deco.js +209 -0
  20. package/dist/v8/analytics/runtime/modules/deco.js.map +1 -0
  21. package/dist/v8/analytics/runtime/modules/engagement.d.ts +2 -0
  22. package/dist/v8/analytics/runtime/modules/engagement.d.ts.map +1 -0
  23. package/dist/v8/analytics/runtime/modules/engagement.js +128 -0
  24. package/dist/v8/analytics/runtime/modules/engagement.js.map +1 -0
  25. package/dist/v8/analytics/runtime/modules/errors.d.ts +2 -0
  26. package/dist/v8/analytics/runtime/modules/errors.d.ts.map +1 -0
  27. package/dist/v8/analytics/runtime/modules/errors.js +167 -0
  28. package/dist/v8/analytics/runtime/modules/errors.js.map +1 -0
  29. package/dist/v8/analytics/runtime/modules/heatmap.d.ts +2 -0
  30. package/dist/v8/analytics/runtime/modules/heatmap.d.ts.map +1 -0
  31. package/dist/v8/analytics/runtime/modules/heatmap.js +316 -0
  32. package/dist/v8/analytics/runtime/modules/heatmap.js.map +1 -0
  33. package/dist/v8/analytics/runtime/modules/vitals.d.ts +2 -0
  34. package/dist/v8/analytics/runtime/modules/vitals.d.ts.map +1 -0
  35. package/dist/v8/analytics/runtime/modules/vitals.js +119 -0
  36. package/dist/v8/analytics/runtime/modules/vitals.js.map +1 -0
  37. package/dist/v8/analytics/runtime/src/guards.d.ts +10 -0
  38. package/dist/v8/analytics/runtime/src/guards.d.ts.map +1 -0
  39. package/dist/v8/analytics/runtime/src/guards.js +70 -0
  40. package/dist/v8/analytics/runtime/src/guards.js.map +1 -0
  41. package/dist/v8/analytics/runtime/src/index.d.ts +2 -0
  42. package/dist/v8/analytics/runtime/src/index.d.ts.map +1 -0
  43. package/dist/v8/analytics/runtime/src/index.js +562 -0
  44. package/dist/v8/analytics/runtime/src/index.js.map +1 -0
  45. package/dist/v8/analytics/runtime/src/queue.d.ts +15 -0
  46. package/dist/v8/analytics/runtime/src/queue.d.ts.map +1 -0
  47. package/dist/v8/analytics/runtime/src/queue.js +36 -0
  48. package/dist/v8/analytics/runtime/src/queue.js.map +1 -0
  49. package/dist/v8/analytics/runtime/src/trim.d.ts +13 -0
  50. package/dist/v8/analytics/runtime/src/trim.d.ts.map +1 -0
  51. package/dist/v8/analytics/runtime/src/trim.js +38 -0
  52. package/dist/v8/analytics/runtime/src/trim.js.map +1 -0
  53. package/dist/v8/analytics/runtime/view/heat-core.d.ts +69 -0
  54. package/dist/v8/analytics/runtime/view/heat-core.d.ts.map +1 -0
  55. package/dist/v8/analytics/runtime/view/heat-core.js +314 -0
  56. package/dist/v8/analytics/runtime/view/heat-core.js.map +1 -0
  57. package/dist/v8/analytics/runtime/view/view.d.ts +51 -0
  58. package/dist/v8/analytics/runtime/view/view.d.ts.map +1 -0
  59. package/dist/v8/analytics/runtime/view/view.js +525 -0
  60. package/dist/v8/analytics/runtime/view/view.js.map +1 -0
  61. package/dist/v8/analytics/shared/anchor.d.ts +71 -0
  62. package/dist/v8/analytics/shared/anchor.d.ts.map +1 -0
  63. package/dist/v8/analytics/shared/anchor.js +155 -0
  64. package/dist/v8/analytics/shared/anchor.js.map +1 -0
  65. package/dist/v8/analytics/shared/contract.d.ts +294 -0
  66. package/dist/v8/analytics/shared/contract.d.ts.map +1 -0
  67. package/dist/v8/analytics/shared/contract.js +652 -0
  68. package/dist/v8/analytics/shared/contract.js.map +1 -0
  69. package/dist/v8/builtins/data.d.ts +20 -6
  70. package/dist/v8/builtins/data.d.ts.map +1 -1
  71. package/dist/v8/builtins/data.js +33 -8
  72. package/dist/v8/builtins/data.js.map +1 -1
  73. package/dist/v8/cms.js +2 -2
  74. package/dist/v8/cms.js.map +1 -1
  75. package/dist/v8/settings.d.ts +28 -9
  76. package/dist/v8/settings.d.ts.map +1 -1
  77. package/dist/v8/settings.js +6 -10
  78. package/dist/v8/settings.js.map +1 -1
  79. package/dist/v8/telemetry.d.ts +13 -11
  80. package/dist/v8/telemetry.d.ts.map +1 -1
  81. package/dist/v8/telemetry.js +27 -17
  82. package/dist/v8/telemetry.js.map +1 -1
  83. package/dist/v8/types.d.ts +7 -3
  84. package/dist/v8/types.d.ts.map +1 -1
  85. package/package.json +6 -1
  86. package/skills/deco-storefront-performance/references/render-location.md +3 -2
  87. package/skills/deco-v7-to-v8-migration/references/telemetry.md +1 -1
  88. package/skills/deco-v7-to-v8-migration/scripts/siteSettings.ts +1 -1
  89. package/src/v8/analytics/client.ts +110 -0
  90. package/src/v8/analytics/runtime/globals.d.ts +36 -0
  91. package/src/v8/analytics/runtime/modules/click.ts +54 -0
  92. package/src/v8/analytics/runtime/modules/commerce.ts +73 -0
  93. package/src/v8/analytics/runtime/modules/consent.ts +150 -0
  94. package/src/v8/analytics/runtime/modules/deco.ts +207 -0
  95. package/src/v8/analytics/runtime/modules/engagement.ts +140 -0
  96. package/src/v8/analytics/runtime/modules/errors.ts +217 -0
  97. package/src/v8/analytics/runtime/modules/heatmap.ts +360 -0
  98. package/src/v8/analytics/runtime/modules/vitals.ts +128 -0
  99. package/src/v8/analytics/runtime/src/guards.ts +70 -0
  100. package/src/v8/analytics/runtime/src/index.ts +606 -0
  101. package/src/v8/analytics/runtime/src/queue.ts +40 -0
  102. package/src/v8/analytics/runtime/src/trim.ts +39 -0
  103. package/src/v8/analytics/runtime/view/heat-core.ts +335 -0
  104. package/src/v8/analytics/runtime/view/view.ts +596 -0
  105. package/src/v8/analytics/shared/anchor.ts +171 -0
  106. package/src/v8/analytics/shared/contract.ts +691 -0
  107. package/src/v8/analytics/tsconfig.json +14 -0
  108. package/src/v8/builtins/data.ts +44 -9
  109. package/src/v8/cms.ts +4 -4
  110. package/src/v8/settings.ts +13 -16
  111. package/src/v8/telemetry.ts +33 -29
  112. package/src/v8/types.ts +7 -3
@@ -0,0 +1,14 @@
1
+ {
2
+ "compilerOptions": {
3
+ "target": "ES2022",
4
+ "lib": ["ES2022", "DOM", "DOM.Iterable"],
5
+ "module": "ESNext",
6
+ "moduleResolution": "bundler",
7
+ "allowImportingTsExtensions": true,
8
+ "noEmit": true,
9
+ "strict": true,
10
+ "skipLibCheck": true,
11
+ "types": []
12
+ },
13
+ "include": ["runtime/**/*.ts", "shared/**/*.ts"]
14
+ }
@@ -42,7 +42,7 @@ export const redirects = (props: {
42
42
  )
43
43
  : [];
44
44
 
45
- /** The `telemetry` section's defaults (sample rates before code's caps). */
45
+ /** The `telemetry` section's built-in defaults; code's `telemetry.defaults` replace the two rates. */
46
46
  export const TELEMETRY_DEFAULTS: Readonly<Required<Telemetry>> = Object.freeze({
47
47
  enabled: true,
48
48
  metrics: true,
@@ -54,14 +54,44 @@ export const TELEMETRY_DEFAULTS: Readonly<Required<Telemetry>> = Object.freeze({
54
54
  export const SETTINGS_BLOCK = "CMS";
55
55
  export const SETTINGS_TYPE = "cms-settings";
56
56
 
57
- /** The `telemetry` section with its defaults filled in; rates as saved, before any cap. */
58
- export function telemetrySection(section: unknown): Required<Telemetry> {
57
+ /** The two sample rates a site falls back to when content saves none. */
58
+ export type SampleRates = { errorSampleRate: number; traceSampleRate: number };
59
+
60
+ /**
61
+ * The `telemetry` section with its defaults filled in: a rate content saved
62
+ * wins (held to 0–1), else `defaults` (code's `telemetry.defaults`, else
63
+ * the built-in ones).
64
+ */
65
+ export function telemetrySection(
66
+ section: unknown,
67
+ defaults: SampleRates = TELEMETRY_DEFAULTS,
68
+ ): Required<Telemetry> {
59
69
  const t = isRecord(section) ? section : {};
60
70
  return {
61
71
  enabled: typeof t.enabled === "boolean" ? t.enabled : TELEMETRY_DEFAULTS.enabled,
62
72
  metrics: typeof t.metrics === "boolean" ? t.metrics : TELEMETRY_DEFAULTS.metrics,
63
- errorSampleRate: rate(t.errorSampleRate, TELEMETRY_DEFAULTS.errorSampleRate),
64
- traceSampleRate: rate(t.traceSampleRate, TELEMETRY_DEFAULTS.traceSampleRate),
73
+ errorSampleRate: rate(t.errorSampleRate, defaults.errorSampleRate),
74
+ traceSampleRate: rate(t.traceSampleRate, defaults.traceSampleRate),
75
+ };
76
+ }
77
+
78
+ /**
79
+ * The `telemetry` section as the `cms-settings` block returns it: switches
80
+ * filled in, sample rates only where content saved one. The block can't see
81
+ * code's `telemetry.defaults`; `cms.settings()` fills the rates from them.
82
+ */
83
+ function savedTelemetry(section: unknown): Telemetry & { enabled: boolean; metrics: boolean } {
84
+ const t = isRecord(section) ? section : {};
85
+ const { enabled, metrics } = telemetrySection(t);
86
+ return {
87
+ enabled,
88
+ metrics,
89
+ ...(typeof t.errorSampleRate === "number" && Number.isFinite(t.errorSampleRate)
90
+ ? { errorSampleRate: rate(t.errorSampleRate, 0) }
91
+ : {}),
92
+ ...(typeof t.traceSampleRate === "number" && Number.isFinite(t.traceSampleRate)
93
+ ? { traceSampleRate: rate(t.traceSampleRate, 0) }
94
+ : {}),
65
95
  };
66
96
  }
67
97
 
@@ -81,14 +111,19 @@ export function analyticsSection(section: unknown): Required<Analytics> {
81
111
 
82
112
  /**
83
113
  * `cms-settings`: the type of the well-known saved block `CMS`. Returns its
84
- * input with the telemetry and analytics defaults filled in. Preview hosts
85
- * aren't here: Studio writes them into the release metadata.
114
+ * input with the telemetry switches and the analytics defaults filled in; a
115
+ * sample rate content didn't save stays out (`cms.settings()` fills it from
116
+ * code's `telemetry.defaults`). Preview hosts aren't here: Studio writes them
117
+ * into the release metadata.
86
118
  */
87
119
  export const cmsSettings = (
88
120
  props: CMSSettings = {},
89
- ): CMSSettings & { telemetry: Required<Telemetry>; analytics: Required<Analytics> } => ({
121
+ ): CMSSettings & {
122
+ telemetry: Telemetry & { enabled: boolean; metrics: boolean };
123
+ analytics: Required<Analytics>;
124
+ } => ({
90
125
  ...props,
91
- telemetry: telemetrySection(props.telemetry),
126
+ telemetry: savedTelemetry(props.telemetry),
92
127
  analytics: analyticsSection(props.analytics),
93
128
  });
94
129
 
package/src/v8/cms.ts CHANGED
@@ -28,13 +28,13 @@ import {
28
28
  previewHosts,
29
29
  readSettings,
30
30
  type SavedSettings,
31
- type SettingsCaps,
31
+ type SettingsDefaults,
32
32
  } from "./settings.ts";
33
33
  import {
34
34
  resolveDestination,
35
35
  setCurrentTelemetry,
36
36
  TelemetryPipeline,
37
- telemetryLimits,
37
+ telemetryDefaults,
38
38
  } from "./telemetry.ts";
39
39
  import type {
40
40
  Blocks,
@@ -84,7 +84,7 @@ class CMSInstance {
84
84
  readonly #interval: number;
85
85
  readonly #warned = new Set<string>();
86
86
  readonly #telemetry: TelemetryPipeline | undefined;
87
- readonly #caps: SettingsCaps;
87
+ readonly #caps: SettingsDefaults;
88
88
  /** Settings of a `CMS` block with nothing to run, per release index. */
89
89
  #staticSettings = new WeakMap<IndexedContent, SavedSettings>();
90
90
  /** Code's `preview.hosts`, parsed: added to the release's own preview hosts, or the only list without a site. */
@@ -105,7 +105,7 @@ class CMSInstance {
105
105
  this.#store = new ContentStore(contentOf(config), parseDraftHosts(config.preview));
106
106
  this.fingerprint = fingerprintOf(config, interval);
107
107
  this.#codeHosts = parseCodeHosts(config.preview);
108
- this.#caps = { limits: telemetryLimits(config.telemetry) };
108
+ this.#caps = { telemetry: telemetryDefaults(config.telemetry) };
109
109
  const destination = resolveDestination(config.telemetry, config.site, config.token);
110
110
  if (destination !== null) {
111
111
  this.#telemetry = new TelemetryPipeline(destination);
@@ -2,15 +2,16 @@
2
2
  * The CMS settings (see /next/built-in-blocks#cms-settings and
3
3
  * /next/api-reference#cms-settings): the saved block `CMS`, of the built-in
4
4
  * type `cms-settings`, read from the release, with the defaults filled in and
5
- * code's caps applied.
5
+ * code's defaults and caps applied.
6
6
  *
7
7
  * - The caller hands in the `CMS` body already in memory (local content
8
8
  * holds it; a hosted index carries it inline); nothing here loads content,
9
9
  * so reading settings never fetches (a section referencing another saved
10
10
  * block resolves it as any read would).
11
11
  * - A missing block, a block of another type, or a section that fails to
12
- * resolve gives that section's defaults, still capped. Nothing rejects.
13
- * - Telemetry rates are the lower of content's and `telemetry.limits`.
12
+ * resolve gives that section's defaults. Nothing rejects.
13
+ * - A telemetry rate content saved wins; else code's `telemetry.defaults`;
14
+ * else the built-in 0.05 and 0. Code doesn't cap content's rates.
14
15
  * - Preview hosts aren't content: Studio writes them into the release
15
16
  * metadata (PO 2026-10-22), and `previewHosts` merges them with code's
16
17
  * `preview.hosts`. A remote site with no list published (no `latest.json`
@@ -20,6 +21,7 @@
20
21
  */
21
22
  import {
22
23
  analyticsSection,
24
+ type SampleRates,
23
25
  SETTINGS_BLOCK,
24
26
  SETTINGS_TYPE,
25
27
  telemetrySection,
@@ -29,9 +31,9 @@ import { EVERY_HOST, formatHostPattern, type HostPattern, parseHostPattern } fro
29
31
  import { isPlainObject } from "./json.ts";
30
32
  import type { Client, CMSConfig, EffectiveSettings } from "./types.ts";
31
33
 
32
- /** What code allows: the caps every section's content is held to. */
33
- export interface SettingsCaps {
34
- limits: { errorSampleRate: number; traceSampleRate: number };
34
+ /** What code decides for content: the sample rates when content saves none. */
35
+ export interface SettingsDefaults {
36
+ telemetry: SampleRates;
35
37
  }
36
38
 
37
39
  /** The settings a release's `CMS` block holds: every section but `preview`, which isn't content. */
@@ -72,8 +74,8 @@ function parseCodePatterns(
72
74
  });
73
75
  }
74
76
 
75
- /** The settings with nothing saved: every default, capped. */
76
- export function defaultSettings(caps: SettingsCaps): SavedSettings {
77
+ /** The settings with nothing saved: every default. */
78
+ export function defaultSettings(caps: SettingsDefaults): SavedSettings {
77
79
  return effectiveSettings({}, caps);
78
80
  }
79
81
 
@@ -85,7 +87,7 @@ export function defaultSettings(caps: SettingsCaps): SavedSettings {
85
87
  export async function readSettings(
86
88
  entry: unknown,
87
89
  client: () => Client,
88
- caps: SettingsCaps,
90
+ caps: SettingsDefaults,
89
91
  ): Promise<SavedSettings> {
90
92
  try {
91
93
  if (!isPlainObject(entry) || entry.__resolveType !== SETTINGS_TYPE) {
@@ -125,14 +127,9 @@ function holdsBlock(value: unknown): boolean {
125
127
  * The settings, deep-frozen: one object per release is handed to every caller,
126
128
  * so a caller that writes to it would change it for every request.
127
129
  */
128
- function effectiveSettings(value: Record<string, unknown>, caps: SettingsCaps): SavedSettings {
129
- const telemetry = telemetrySection(value.telemetry);
130
+ function effectiveSettings(value: Record<string, unknown>, caps: SettingsDefaults): SavedSettings {
130
131
  return deepFreeze({
131
- telemetry: {
132
- ...telemetry,
133
- errorSampleRate: Math.min(telemetry.errorSampleRate, caps.limits.errorSampleRate),
134
- traceSampleRate: Math.min(telemetry.traceSampleRate, caps.limits.traceSampleRate),
135
- },
132
+ telemetry: telemetrySection(value.telemetry, caps.telemetry),
136
133
  analytics: analyticsSection(value.analytics),
137
134
  });
138
135
  }
@@ -7,8 +7,8 @@
7
7
  * `token` (sent as a Bearer token), else nowhere. `false` sends nothing.
8
8
  * Nothing is read from the environment.
9
9
  * - **How much** comes from content: the `telemetry` section of the CMS
10
- * settings (`cms.settings()`, the release's `CMS` block), capped by
11
- * `telemetry.limits`. The CMS reads it outside any request, when the
10
+ * settings (`cms.settings()`, the release's `CMS` block); a rate it doesn't
11
+ * save is code's `telemetry.defaults`, else the built-in 0.05 and 0. The CMS reads it outside any request, when the
12
12
  * release changes and then at most once a minute.
13
13
  * - Metrics are aggregated in memory (delta histograms); error logs and traces
14
14
  * are sampled. Batches leave in the background (after the response on
@@ -18,7 +18,7 @@
18
18
  * cookies or authorization values.
19
19
  */
20
20
  import { hasBackgroundHook, later, runInBackground } from "./background.ts";
21
- import { rate, TELEMETRY_DEFAULTS } from "./builtins/data.ts";
21
+ import { rate, type SampleRates, TELEMETRY_DEFAULTS } from "./builtins/data.ts";
22
22
  import { isResolutionError } from "./errors.ts";
23
23
  import type { CMSError, Telemetry, TelemetryConfig } from "./types.ts";
24
24
 
@@ -32,17 +32,25 @@ const MAX_SPANS = 1_000;
32
32
  const RETRY_STATUSES = new Set([429, 502, 503, 504]);
33
33
  /** OpenTelemetry's recommended `http.*.request.duration` buckets, in seconds. */
34
34
  const BOUNDS = [0.005, 0.01, 0.025, 0.05, 0.075, 0.1, 0.25, 0.5, 0.75, 1, 2.5, 5, 7.5, 10];
35
- const DEFAULT_LIMITS = { errorSampleRate: 0.1, traceSampleRate: 0 };
36
-
37
- /** The caps on content's sample rates: `telemetry.limits`, defaults 0.1 and 0. */
38
- export function telemetryLimits(config: false | TelemetryConfig | undefined): {
39
- errorSampleRate: number;
40
- traceSampleRate: number;
41
- } {
42
- const limits = config ? config.limits : undefined;
35
+
36
+ /**
37
+ * Code's sample rates for when content saves none: `telemetry.defaults`, each
38
+ * rate falling back to the built-in one. `telemetry.limits` was removed (it
39
+ * capped content's rates); a config still passing it is a TypeError, so a
40
+ * site can't keep a cap it believes in.
41
+ */
42
+ export function telemetryDefaults(config: false | TelemetryConfig | undefined): SampleRates {
43
+ if (config && "limits" in config) {
44
+ throw new TypeError(
45
+ "createCMS: `telemetry.limits` was removed. Rename it to `telemetry.defaults`: " +
46
+ "code now sets the sample rates content doesn't save, and content's win " +
47
+ "(see /next/telemetry#sampling)",
48
+ );
49
+ }
50
+ const defaults = config ? config.defaults : undefined;
43
51
  return {
44
- errorSampleRate: rate(limits?.errorSampleRate, DEFAULT_LIMITS.errorSampleRate),
45
- traceSampleRate: rate(limits?.traceSampleRate, DEFAULT_LIMITS.traceSampleRate),
52
+ errorSampleRate: rate(defaults?.errorSampleRate, TELEMETRY_DEFAULTS.errorSampleRate),
53
+ traceSampleRate: rate(defaults?.traceSampleRate, TELEMETRY_DEFAULTS.traceSampleRate),
46
54
  };
47
55
  }
48
56
 
@@ -57,7 +65,8 @@ interface Destination {
57
65
  site?: string;
58
66
  /** `telemetry.resource`: merged over the default resource attributes. */
59
67
  resource: Record<string, string>;
60
- limits: { errorSampleRate: number; traceSampleRate: number };
68
+ /** Code's sample rates for when content saves none. */
69
+ defaults: SampleRates;
61
70
  }
62
71
 
63
72
  interface SpanInput {
@@ -106,10 +115,10 @@ export function resolveDestination(
106
115
  ): Destination | null {
107
116
  if (config === false) return null;
108
117
  // OPEN: no per-signal URLs (v7's OTEL_EXPORTER_OTLP_<SIGNAL>_ENDPOINT): every signal goes to `<endpoint>/v1/<signal>`.
109
- const limits = telemetryLimits(config);
118
+ const defaults = telemetryDefaults(config);
110
119
  const resource = { ...config?.resource };
111
120
  if (typeof config?.endpoint === "string" && config.endpoint) {
112
- return { endpoint: config.endpoint, headers: { ...config.headers }, site, resource, limits };
121
+ return { endpoint: config.endpoint, headers: { ...config.headers }, site, resource, defaults };
113
122
  }
114
123
  if (!token) return null;
115
124
  return {
@@ -117,7 +126,7 @@ export function resolveDestination(
117
126
  headers: { authorization: `Bearer ${token}` },
118
127
  site,
119
128
  resource,
120
- limits,
129
+ defaults,
121
130
  };
122
131
  }
123
132
 
@@ -133,7 +142,7 @@ export class TelemetryPipeline {
133
142
 
134
143
  constructor(destination: Destination) {
135
144
  this.#destination = destination;
136
- this.apply(TELEMETRY_DEFAULTS);
145
+ this.apply({});
137
146
  }
138
147
 
139
148
  /** The release being served: its revision labels batches. */
@@ -142,22 +151,17 @@ export class TelemetryPipeline {
142
151
  }
143
152
 
144
153
  /**
145
- * The `telemetry` section to follow (from `cms.settings()`). Rates are
146
- * capped by the destination's limits here too, whatever the caller passed.
154
+ * The `telemetry` section to follow (from `cms.settings()`). A rate the
155
+ * section leaves out is the destination's default (code's
156
+ * `telemetry.defaults`, else the built-in one); one it sets wins.
147
157
  */
148
158
  apply(section: Telemetry): void {
149
- const { limits } = this.#destination;
159
+ const { defaults } = this.#destination;
150
160
  this.#settings = {
151
161
  enabled: typeof section.enabled === "boolean" ? section.enabled : TELEMETRY_DEFAULTS.enabled,
152
162
  metrics: typeof section.metrics === "boolean" ? section.metrics : TELEMETRY_DEFAULTS.metrics,
153
- errorSampleRate: Math.min(
154
- rate(section.errorSampleRate, TELEMETRY_DEFAULTS.errorSampleRate),
155
- limits.errorSampleRate,
156
- ),
157
- traceSampleRate: Math.min(
158
- rate(section.traceSampleRate, TELEMETRY_DEFAULTS.traceSampleRate),
159
- limits.traceSampleRate,
160
- ),
163
+ errorSampleRate: rate(section.errorSampleRate, defaults.errorSampleRate),
164
+ traceSampleRate: rate(section.traceSampleRate, defaults.traceSampleRate),
161
165
  };
162
166
  }
163
167
 
package/src/v8/types.ts CHANGED
@@ -178,9 +178,9 @@ export interface Telemetry {
178
178
  enabled?: boolean;
179
179
  /** Default `true`. */
180
180
  metrics?: boolean;
181
- /** Default 0.05, capped by `telemetry.limits`. */
181
+ /** 0 to 1. When not saved: `telemetry.defaults` from code, else 0.05. */
182
182
  errorSampleRate?: number;
183
- /** Default 0, capped by `telemetry.limits`. */
183
+ /** 0 to 1. When not saved: `telemetry.defaults` from code, else 0. */
184
184
  traceSampleRate?: number;
185
185
  }
186
186
 
@@ -249,7 +249,11 @@ export interface TelemetryConfig {
249
249
  * `service.version`, `deployment.environment.name`, …).
250
250
  */
251
251
  resource?: Record<string, string>;
252
- limits?: { errorSampleRate?: number; traceSampleRate?: number };
252
+ /**
253
+ * The sample rates when the `telemetry` section of the CMS settings saves
254
+ * none (built-in: 0.05 and 0). A rate content saves wins, from 0 to 1.
255
+ */
256
+ defaults?: { errorSampleRate?: number; traceSampleRate?: number };
253
257
  }
254
258
 
255
259
  export interface CMSConfig {