@copilotkit/shared 1.72.0 → 1.73.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.
- package/LICENSE +21 -0
- package/dist/finalize-events.cjs +92 -71
- package/dist/finalize-events.cjs.map +1 -1
- package/dist/finalize-events.d.cts +20 -1
- package/dist/finalize-events.d.cts.map +1 -1
- package/dist/finalize-events.d.mts +20 -1
- package/dist/finalize-events.d.mts.map +1 -1
- package/dist/finalize-events.mjs +92 -72
- package/dist/finalize-events.mjs.map +1 -1
- package/dist/index.cjs +7 -0
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +4 -3
- package/dist/index.d.cts.map +1 -1
- package/dist/index.d.mts +4 -3
- package/dist/index.d.mts.map +1 -1
- package/dist/index.mjs +4 -3
- package/dist/index.mjs.map +1 -1
- package/dist/index.umd.js +218 -72
- package/dist/index.umd.js.map +1 -1
- package/dist/package.cjs +1 -1
- package/dist/package.mjs +1 -1
- package/dist/telemetry/events.d.cts +33 -0
- package/dist/telemetry/events.d.cts.map +1 -1
- package/dist/telemetry/events.d.mts +33 -0
- package/dist/telemetry/events.d.mts.map +1 -1
- package/dist/telemetry/index.cjs +3 -0
- package/dist/telemetry/index.d.cts +2 -2
- package/dist/telemetry/index.d.mts +2 -2
- package/dist/telemetry/index.mjs +2 -2
- package/dist/telemetry/model-host.cjs +104 -0
- package/dist/telemetry/model-host.cjs.map +1 -0
- package/dist/telemetry/model-host.d.cts +26 -0
- package/dist/telemetry/model-host.d.cts.map +1 -0
- package/dist/telemetry/model-host.d.mts +26 -0
- package/dist/telemetry/model-host.d.mts.map +1 -0
- package/dist/telemetry/model-host.mjs +102 -0
- package/dist/telemetry/model-host.mjs.map +1 -0
- package/dist/telemetry/sampling.cjs +22 -0
- package/dist/telemetry/sampling.cjs.map +1 -1
- package/dist/telemetry/sampling.d.cts +22 -2
- package/dist/telemetry/sampling.d.cts.map +1 -1
- package/dist/telemetry/sampling.d.mts +22 -2
- package/dist/telemetry/sampling.d.mts.map +1 -1
- package/dist/telemetry/sampling.mjs +20 -1
- package/dist/telemetry/sampling.mjs.map +1 -1
- package/dist/telemetry/telemetry-client.cjs +18 -11
- package/dist/telemetry/telemetry-client.cjs.map +1 -1
- package/dist/telemetry/telemetry-client.d.cts +3 -3
- package/dist/telemetry/telemetry-client.d.cts.map +1 -1
- package/dist/telemetry/telemetry-client.d.mts +3 -3
- package/dist/telemetry/telemetry-client.d.mts.map +1 -1
- package/dist/telemetry/telemetry-client.mjs +19 -12
- package/dist/telemetry/telemetry-client.mjs.map +1 -1
- package/package.json +1 -1
- package/src/finalize-events.test.ts +146 -0
- package/src/finalize-events.ts +124 -124
- package/src/index.ts +9 -1
- package/src/telemetry/events.ts +33 -0
- package/src/telemetry/model-host.test.ts +145 -0
- package/src/telemetry/model-host.ts +155 -0
- package/src/telemetry/sampling.ts +39 -6
- package/src/telemetry/telemetry-blank-license-identity.test.ts +11 -4
- package/src/telemetry/telemetry-client.test.ts +107 -39
- package/src/telemetry/telemetry-client.ts +48 -27
|
@@ -7,7 +7,12 @@ import {
|
|
|
7
7
|
lambdaClient,
|
|
8
8
|
parseAndWarnTelemetryId,
|
|
9
9
|
} from "./lambda-client";
|
|
10
|
-
import {
|
|
10
|
+
import {
|
|
11
|
+
computeSamplingMeta,
|
|
12
|
+
TELEMETRY_EMITTER_V1,
|
|
13
|
+
TELEMETRY_SURFACE_V1,
|
|
14
|
+
UNSAMPLED_RATE,
|
|
15
|
+
} from "./sampling";
|
|
11
16
|
import { isTelemetryDisabled } from "./telemetry-disabled";
|
|
12
17
|
|
|
13
18
|
export { isTelemetryDisabled };
|
|
@@ -45,16 +50,18 @@ export class TelemetryClient {
|
|
|
45
50
|
// the Lambda transport.
|
|
46
51
|
private telemetryId: string | null = null;
|
|
47
52
|
// License-derived identity used only as sampling authority. A standalone
|
|
48
|
-
// telemetry id remains a transport claim and does not bypass
|
|
53
|
+
// telemetry id remains a transport claim and does not bypass the
|
|
54
|
+
// Segment gate.
|
|
49
55
|
private licenseTelemetryId: string | null = null;
|
|
50
56
|
packageName: string;
|
|
51
57
|
packageVersion: string;
|
|
52
58
|
private telemetryDisabled: boolean = false;
|
|
53
|
-
// Client-side sampling rate for anonymous events
|
|
54
|
-
//
|
|
55
|
-
//
|
|
56
|
-
//
|
|
57
|
-
|
|
59
|
+
// Client-side sampling rate for anonymous events on the Segment wire
|
|
60
|
+
// only. The lambda sink is ours and takes every event; Segment is
|
|
61
|
+
// billed per event, so the anonymous population stays capped there.
|
|
62
|
+
// Identified events (those whose license token yielded a telemetry_id)
|
|
63
|
+
// bypass the gate on both wires.
|
|
64
|
+
private segmentSampleRate: number = 0.05;
|
|
58
65
|
private anonymousId = `anon_${uuidv4()}`;
|
|
59
66
|
|
|
60
67
|
constructor({
|
|
@@ -68,6 +75,8 @@ export class TelemetryClient {
|
|
|
68
75
|
packageVersion: string;
|
|
69
76
|
telemetryDisabled?: boolean;
|
|
70
77
|
telemetryBaseUrl?: string;
|
|
78
|
+
// Anonymous sampling rate for the Segment wire. Named without the
|
|
79
|
+
// prefix for backward compatibility; the lambda sink ignores it.
|
|
71
80
|
sampleRate?: number;
|
|
72
81
|
}) {
|
|
73
82
|
this.packageName = packageName;
|
|
@@ -95,9 +104,9 @@ export class TelemetryClient {
|
|
|
95
104
|
});
|
|
96
105
|
}
|
|
97
106
|
|
|
98
|
-
private
|
|
107
|
+
private shouldSendToSegment() {
|
|
99
108
|
const randomNumber = Math.random();
|
|
100
|
-
return randomNumber < this.
|
|
109
|
+
return randomNumber < this.segmentSampleRate;
|
|
101
110
|
}
|
|
102
111
|
|
|
103
112
|
async capture<K extends keyof AnalyticsEvents>(
|
|
@@ -120,19 +129,29 @@ export class TelemetryClient {
|
|
|
120
129
|
return;
|
|
121
130
|
}
|
|
122
131
|
|
|
123
|
-
//
|
|
124
|
-
//
|
|
125
|
-
//
|
|
126
|
-
//
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
132
|
+
// The two wires are gated separately. The lambda sink takes every
|
|
133
|
+
// event: it is CopilotKit-owned, so anonymous volume costs nothing
|
|
134
|
+
// per event there and a real count beats one extrapolated from 5% of
|
|
135
|
+
// the population. Segment is billed per event, so it keeps the gate —
|
|
136
|
+
// callers without license-derived sampling authority are dropped from
|
|
137
|
+
// that copy at segmentSampleRate. Legacy license tokens with a
|
|
138
|
+
// telemetry_id send on both wires: the volume is bounded by
|
|
139
|
+
// paying-customer count and full fidelity per identified customer is
|
|
140
|
+
// worth the marginal cost.
|
|
141
|
+
const sendToSegment =
|
|
142
|
+
Boolean(identity.licenseTelemetryId) || this.shouldSendToSegment();
|
|
130
143
|
|
|
131
144
|
// Sampling metadata is computed in ./sampling so this client and the
|
|
132
145
|
// v2 runtime client can't drift apart again — see the note there.
|
|
133
|
-
|
|
146
|
+
// One call per wire, because the two wires were gated differently and
|
|
147
|
+
// a shared block would overweight the lambda copy by 1/sampleRate.
|
|
148
|
+
const lambdaSamplingMeta = computeSamplingMeta({
|
|
149
|
+
telemetryId: identity.licenseTelemetryId,
|
|
150
|
+
sampleRate: UNSAMPLED_RATE,
|
|
151
|
+
});
|
|
152
|
+
const segmentSamplingMeta = computeSamplingMeta({
|
|
134
153
|
telemetryId: identity.licenseTelemetryId,
|
|
135
|
-
sampleRate: this.
|
|
154
|
+
sampleRate: this.segmentSampleRate,
|
|
136
155
|
});
|
|
137
156
|
|
|
138
157
|
// Everything below travels identically on both copies of this event.
|
|
@@ -142,8 +161,8 @@ export class TelemetryClient {
|
|
|
142
161
|
// duplication from $lib or from which fields happen to be present
|
|
143
162
|
// (OSS-1019).
|
|
144
163
|
const eventMeta = {
|
|
145
|
-
...samplingMeta,
|
|
146
164
|
telemetry_emitter: TELEMETRY_EMITTER_V1,
|
|
165
|
+
telemetry_surface: TELEMETRY_SURFACE_V1,
|
|
147
166
|
telemetry_event_id: uuidv4(),
|
|
148
167
|
};
|
|
149
168
|
|
|
@@ -151,6 +170,7 @@ export class TelemetryClient {
|
|
|
151
170
|
const propertiesWithGlobal: Record<string, any> = {
|
|
152
171
|
...this.globalProperties,
|
|
153
172
|
...eventMeta,
|
|
173
|
+
...segmentSamplingMeta,
|
|
154
174
|
telemetry_transport: "segment",
|
|
155
175
|
...flattenedProperties,
|
|
156
176
|
};
|
|
@@ -170,6 +190,7 @@ export class TelemetryClient {
|
|
|
170
190
|
globalProperties: {
|
|
171
191
|
...this.globalProperties,
|
|
172
192
|
...eventMeta,
|
|
193
|
+
...lambdaSamplingMeta,
|
|
173
194
|
telemetry_transport: "lambda",
|
|
174
195
|
},
|
|
175
196
|
packageName: this.packageName,
|
|
@@ -178,7 +199,7 @@ export class TelemetryClient {
|
|
|
178
199
|
licenseToken: identity.licenseToken ?? undefined,
|
|
179
200
|
});
|
|
180
201
|
|
|
181
|
-
if (this.segment) {
|
|
202
|
+
if (this.segment && sendToSegment) {
|
|
182
203
|
this.segment.track({
|
|
183
204
|
anonymousId: this.anonymousId,
|
|
184
205
|
event,
|
|
@@ -238,7 +259,7 @@ export class TelemetryClient {
|
|
|
238
259
|
* Create an immutable capture scope for one runtime.
|
|
239
260
|
*
|
|
240
261
|
* The scope shares this client's sinks, process-wide opt-out, global
|
|
241
|
-
* properties, and sampling
|
|
262
|
+
* properties, and Segment sampling rate, but snapshots transport identity and
|
|
242
263
|
* license-derived sampling authority. Constructing another runtime cannot
|
|
243
264
|
* rewrite an existing scope.
|
|
244
265
|
*
|
|
@@ -290,16 +311,16 @@ export class TelemetryClient {
|
|
|
290
311
|
|
|
291
312
|
// Number.isNaN guards against parseFloat("nonsense") slipping past the
|
|
292
313
|
// range check (all NaN comparisons are false), which would silently
|
|
293
|
-
// drop every anonymous event with no signal
|
|
294
|
-
// since the default is now 0.05, making env-var overrides more common.
|
|
314
|
+
// drop every anonymous Segment event with no signal.
|
|
295
315
|
if (Number.isNaN(_sampleRate) || _sampleRate < 0 || _sampleRate > 1) {
|
|
296
316
|
throw new Error("Sample rate must be between 0 and 1");
|
|
297
317
|
}
|
|
298
318
|
|
|
299
|
-
this.
|
|
319
|
+
this.segmentSampleRate = _sampleRate;
|
|
300
320
|
// Per-event sampling metadata (sampleRate/sampleRateAdjustmentFactor/
|
|
301
|
-
// sampleWeight) is computed per capture() in ./sampling
|
|
302
|
-
// authorized events get effectiveSampleRate=1
|
|
303
|
-
// identity stays in the
|
|
321
|
+
// sampleWeight) is computed per capture() in ./sampling, once per
|
|
322
|
+
// wire. Only license-authorized events get effectiveSampleRate=1 on
|
|
323
|
+
// the Segment copy; standalone transport identity stays in the
|
|
324
|
+
// sampled population there. The lambda copy is always unsampled.
|
|
304
325
|
}
|
|
305
326
|
}
|