@flareapp/core 2.10.0 → 2.12.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/dist/index.cjs +101 -114
- package/dist/index.d.cts +81 -49
- package/dist/index.d.mts +81 -49
- package/dist/index.mjs +96 -113
- package/dist/{urlAttributes-CYsfTfi9.d.mts → urlAttributes-CU2Yr37w.d.cts} +24 -9
- package/dist/{urlAttributes-B37JykP3.cjs → urlAttributes-D0eXRrGm.cjs} +35 -24
- package/dist/{urlAttributes-DeDN7qtu.mjs → urlAttributes-ggdpIKSS.mjs} +24 -25
- package/dist/{urlAttributes-DW_i-YQ3.d.cts → urlAttributes-rWoVW31H.d.mts} +24 -9
- package/dist/util/index.cjs +3 -1
- package/dist/util/index.d.cts +2 -2
- package/dist/util/index.d.mts +2 -2
- package/dist/util/index.mjs +2 -2
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { $ as
|
|
1
|
+
import { $ as StackFrame, A as AttributeValue, B as LogsEnvelope, C as createIdentityTagger, D as assertKey, F as EntryPointHandler, G as Report, H as OtelLogRecord, I as EntryPointType, J as Span, K as SamplingContext, L as Framework, M as BufferedLog, N as BufferedSpan, O as assert, P as Config, Q as SpanStatusCode, R as Glow, S as SdkTaggable, U as OtelSpan, V as MessageLevel, W as OverriddenGrouping, X as SpanOptions, Y as SpanEvent, Z as SpanStatus, at as SpanTypeName, b as extractCode, c as RejectionReporter, d as DEFAULT_URL_DENYLIST, et as TracesEnvelope, f as redactObjectValues, g as now, h as safeDecode, it as BrowserSpanType, j as Attributes, k as AnyValue, l as describeRejectionReason, m as resolveDenylist, n as urlAttributes, nt as User, o as SafeCloneOptions, ot as FrameworkName, p as redactUrlQuery, q as SdkInfo, r as toCustomContext, rt as BrowserSpanEventType, s as safeClone, tt as TracesSampler, u as routeRejection, v as glowsToEvents, w as convertToError, x as evictLruIfNew, y as flatJsonStringify, z as KeyValue } from "./urlAttributes-rWoVW31H.mjs";
|
|
2
2
|
|
|
3
3
|
//#region src/api/Api.d.ts
|
|
4
4
|
declare class Api {
|
|
@@ -6,8 +6,7 @@ declare class Api {
|
|
|
6
6
|
private pendingKeepaliveRequests;
|
|
7
7
|
/**
|
|
8
8
|
* How many keepalive bytes are still available. Logs and traces share one browser allowance and both
|
|
9
|
-
* flush on page hide, so whichever goes second
|
|
10
|
-
* whole budget, or it exceeds the gate in send() and silently degrades to a cancellable fetch.
|
|
9
|
+
* flush on page hide, so whichever goes second must pack against what is left, not the whole budget.
|
|
11
10
|
*/
|
|
12
11
|
keepaliveBudgetRemaining(): number;
|
|
13
12
|
report(report: Report, url: string, key: string | null, reportBrowserExtensionErrors: boolean, debug?: boolean): Promise<void>;
|
|
@@ -127,14 +126,13 @@ declare function readLinesFromFile(fileText: string, lineNumber: number, columnN
|
|
|
127
126
|
interface ActiveSpanHolder {
|
|
128
127
|
getActive(): Span | undefined;
|
|
129
128
|
/**
|
|
130
|
-
*
|
|
131
|
-
* holder can
|
|
129
|
+
* Runs `fn` with `span` active, then restores the previous active span. Takes a callback, not a
|
|
130
|
+
* setter, so a Node holder can implement it with `AsyncLocalStorage.run(...)`.
|
|
132
131
|
*/
|
|
133
132
|
withActive<T>(span: Span, fn: () => T): T;
|
|
134
133
|
/**
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
* omits it simply has no active-root support.
|
|
134
|
+
* Fallback span that getActive() returns when no withActive scope is active. Long-lived
|
|
135
|
+
* pageload/navigation roots use it so child spans auto-parent to them. Optional.
|
|
138
136
|
*/
|
|
139
137
|
setActiveRoot?(span: Span | undefined): void;
|
|
140
138
|
}
|
|
@@ -187,10 +185,9 @@ declare class Tracer {
|
|
|
187
185
|
getActiveSpan(): Span | undefined;
|
|
188
186
|
setActiveRoot(span?: Span): void;
|
|
189
187
|
/**
|
|
190
|
-
*
|
|
191
|
-
*
|
|
192
|
-
*
|
|
193
|
-
* Consumed by the matching `startSpan({ claimed: true })`.
|
|
188
|
+
* Claims a span slot before the span exists, for a caller that publishes a span id early (the
|
|
189
|
+
* component profilers do; their descendants record first). Returns false when the trace is full.
|
|
190
|
+
* Paired with `startSpan({ claimed: true })`.
|
|
194
191
|
*/
|
|
195
192
|
claimSpanSlot(traceId: string): boolean;
|
|
196
193
|
addSpanListener(fn: SpanLifecycleListener): () => void;
|
|
@@ -201,20 +198,20 @@ declare class Tracer {
|
|
|
201
198
|
clear(): void;
|
|
202
199
|
continueFromTraceparent(header: string): void;
|
|
203
200
|
/**
|
|
204
|
-
* Runs `fn` with the span active, so spans started inside auto-parent to it, then ends
|
|
201
|
+
* Runs `fn` with the span active, so spans started inside it auto-parent to it, then ends the span.
|
|
205
202
|
* Records an error status first if `fn` throws or its returned promise rejects.
|
|
206
203
|
*/
|
|
207
204
|
withSpan<T>(name: string, fn: (span: Span) => T, opts?: SpanOptions): T;
|
|
208
|
-
/**
|
|
209
|
-
*
|
|
205
|
+
/**
|
|
206
|
+
* Starts a span the caller must end. Unlike `withSpan`, it does not become the active span, so spans
|
|
207
|
+
* started after it do not auto-parent to it.
|
|
208
|
+
*/
|
|
210
209
|
startSpan(name: string, opts?: SpanOptions): Span;
|
|
211
|
-
/** A real Span handle that records nothing, so callers never have to branch on whether tracing is on. */
|
|
212
210
|
private startInertSpan;
|
|
213
211
|
private resolveTrace;
|
|
214
212
|
private getOrSeedState;
|
|
215
213
|
private createState;
|
|
216
214
|
private makeSpan;
|
|
217
|
-
/** Bounded, LRU by insertion order, like traceStates. Holds primitives only, never a span. */
|
|
218
215
|
private rememberClosed;
|
|
219
216
|
private onSpanEnd;
|
|
220
217
|
}
|
|
@@ -246,22 +243,13 @@ declare class Flare {
|
|
|
246
243
|
* default; a platform can back it with AsyncLocalStorage instead.
|
|
247
244
|
*/
|
|
248
245
|
constructor(api?: Api, contextCollector?: ContextCollector, fileReader?: FileReader, scopeProvider?: ScopeProvider, scheduler?: FlushScheduler, activeSpanHolder?: ActiveSpanHolder);
|
|
249
|
-
/**
|
|
250
|
-
* Register an in-flight report so `flush()` can wait for it. Every entry point wraps its whole async
|
|
251
|
-
* pipeline, from beforeEvaluate through api.report, so flush() waits on all of it.
|
|
252
|
-
*
|
|
253
|
-
* What goes in the Set is a shadow promise that mirrors `p`'s timing but cannot reject, so a failed
|
|
254
|
-
* report never surfaces as an unhandled rejection warning. `p` itself is returned untouched, so the
|
|
255
|
-
* caller still observes real success or failure.
|
|
256
|
-
*/
|
|
257
246
|
private track;
|
|
258
247
|
/**
|
|
259
|
-
*
|
|
260
|
-
*
|
|
261
|
-
* drain any other concurrent reports before `process.exit`.
|
|
248
|
+
* Waits until every in-flight report settles, or `timeoutMs` elapses. Always resolves, never rejects.
|
|
249
|
+
* Used by `@flareapp/node`'s fatal handler to drain other reports before `process.exit`.
|
|
262
250
|
*
|
|
263
|
-
*
|
|
264
|
-
*
|
|
251
|
+
* Only reports already in flight are awaited, so a handler still emitting during shutdown cannot block
|
|
252
|
+
* forever. Call flush again to catch those.
|
|
265
253
|
*/
|
|
266
254
|
flush(timeoutMs?: number): Promise<void>;
|
|
267
255
|
get config(): Readonly<Config>;
|
|
@@ -298,10 +286,6 @@ declare class Flare {
|
|
|
298
286
|
setEntryPoint(handler: EntryPointHandler): this;
|
|
299
287
|
setSdkInfo(info: SdkInfo): this;
|
|
300
288
|
setFramework(framework: Framework): this;
|
|
301
|
-
/**
|
|
302
|
-
* True when a report must not be captured: consent withdrawn, or dropped by sampling. Consent is
|
|
303
|
-
* checked first, so a blocked report never runs the sampler or assembles a report (no cookie read).
|
|
304
|
-
*/
|
|
305
289
|
private shouldSkipCapture;
|
|
306
290
|
report(error: Error, attributes?: Attributes): Promise<void>;
|
|
307
291
|
private reportInternal;
|
|
@@ -314,15 +298,6 @@ declare class Flare {
|
|
|
314
298
|
private buildBaseAttributes;
|
|
315
299
|
private assembleAttributes;
|
|
316
300
|
private buildLogAttributes;
|
|
317
|
-
/**
|
|
318
|
-
* Local roots only, snapshotted by the Tracer at span START so a long-lived root does not drift into
|
|
319
|
-
* the next page's scope. Children get none, and no span ever runs the DOM collector.
|
|
320
|
-
*
|
|
321
|
-
* Everything assembled is inherited except user identity (excluding the opaque `user.id`): a root span
|
|
322
|
-
* goes out for every page view, so email, full name, IP and `user.attributes` would turn normal
|
|
323
|
-
* browsing into PII traffic. The rest — `context.custom`, `addContextGroup` bags — stays in, because
|
|
324
|
-
* the trace viewer renders any span attribute whose key does not start with `flare.`.
|
|
325
|
-
*/
|
|
326
301
|
private getScopeAttributes;
|
|
327
302
|
private spanResourceAttributes;
|
|
328
303
|
private buildReport;
|
|
@@ -350,17 +325,74 @@ declare function spanId(): string;
|
|
|
350
325
|
//#endregion
|
|
351
326
|
//#region src/stacktrace/NullFileReader.d.ts
|
|
352
327
|
/**
|
|
353
|
-
* No-op `FileReader` returning `null` for every URL. Default for `Flare`'s `fileReader` param so
|
|
354
|
-
* reports without picking an environment; stack frames just omit source snippets.
|
|
355
|
-
*
|
|
356
|
-
* interface lets the stack-trace builder treat all three the same (render on text, skip on null), so core needs no
|
|
357
|
-
* environment checks.
|
|
328
|
+
* No-op `FileReader` returning `null` for every URL. Default for `Flare`'s `fileReader` param, so
|
|
329
|
+
* `new Flare()` builds reports without picking an environment; stack frames just omit source snippets.
|
|
330
|
+
* `@flareapp/js` and `@flareapp/node` inject a real fetch- or disk-based reader instead.
|
|
358
331
|
*/
|
|
359
332
|
declare class NullFileReader implements FileReader {
|
|
360
333
|
read(_url: string): Promise<string | null>;
|
|
361
334
|
}
|
|
362
335
|
//#endregion
|
|
336
|
+
//#region src/device/types.d.ts
|
|
337
|
+
/** Effective connection quality. The API never reports 5g: a 5g device reports '4g'. */
|
|
338
|
+
type EffectiveConnectionType = 'slow-2g' | '2g' | '3g' | '4g';
|
|
339
|
+
/** Normalised device info. Every field optional: each provider fills what it reads, the mapper drops the rest. */
|
|
340
|
+
type DeviceInfo = {
|
|
341
|
+
os?: {
|
|
342
|
+
name?: string;
|
|
343
|
+
version?: string;
|
|
344
|
+
};
|
|
345
|
+
runtime?: {
|
|
346
|
+
name?: string;
|
|
347
|
+
version?: string;
|
|
348
|
+
};
|
|
349
|
+
device?: {
|
|
350
|
+
type?: string;
|
|
351
|
+
model?: string;
|
|
352
|
+
memoryGb?: number;
|
|
353
|
+
cpuCores?: number;
|
|
354
|
+
screen?: {
|
|
355
|
+
width?: number;
|
|
356
|
+
height?: number;
|
|
357
|
+
scale?: number;
|
|
358
|
+
};
|
|
359
|
+
};
|
|
360
|
+
network?: {
|
|
361
|
+
effectiveType?: EffectiveConnectionType;
|
|
362
|
+
downlinkMbps?: number;
|
|
363
|
+
rttMs?: number;
|
|
364
|
+
online?: boolean;
|
|
365
|
+
};
|
|
366
|
+
app?: {
|
|
367
|
+
version?: string;
|
|
368
|
+
id?: string;
|
|
369
|
+
};
|
|
370
|
+
locale?: {
|
|
371
|
+
language?: string;
|
|
372
|
+
timezone?: string;
|
|
373
|
+
};
|
|
374
|
+
};
|
|
375
|
+
//#endregion
|
|
376
|
+
//#region src/device/DeviceInfoProvider.d.ts
|
|
377
|
+
/** The seam each platform implements to read device info. A `ContextCollector` maps it with `deviceInfoToAttributes`. */
|
|
378
|
+
interface DeviceInfoProvider {
|
|
379
|
+
collect(): DeviceInfo;
|
|
380
|
+
}
|
|
381
|
+
/** Default for platforms with no device info. */
|
|
382
|
+
declare class NullDeviceInfoProvider implements DeviceInfoProvider {
|
|
383
|
+
collect(): DeviceInfo;
|
|
384
|
+
}
|
|
385
|
+
//#endregion
|
|
386
|
+
//#region src/device/deviceInfoToAttributes.d.ts
|
|
387
|
+
/** Map `DeviceInfo` to wire attributes: flat keys plus a `context.device` card. Shared by every SDK, so keys never drift. */
|
|
388
|
+
declare function deviceInfoToAttributes(info: DeviceInfo): Attributes;
|
|
389
|
+
/**
|
|
390
|
+
* `context.device` card for the error UI. Rendered one level deep, so values stay scalar. Built only when
|
|
391
|
+
* a device or network signal exists (an os-only Node report gets none).
|
|
392
|
+
*/
|
|
393
|
+
declare function buildDeviceContextGroup(info: DeviceInfo): Record<string, AttributeValue>;
|
|
394
|
+
//#endregion
|
|
363
395
|
//#region src/stacktrace/createStackTrace.d.ts
|
|
364
396
|
declare function createStackTrace(error: Error, debug: boolean, fileReader: FileReader): Promise<Array<StackFrame>>;
|
|
365
397
|
//#endregion
|
|
366
|
-
export { type ActiveSpanHolder, type AnyValue, Api, type AttributeValue, type Attributes, BrowserSpanEventType, BrowserSpanType, type BufferedLog, type BufferedSpan, type Config, type ContextCollector, DEFAULT_MAX_LIVE_TRACES, DEFAULT_URL_DENYLIST, type EntryPointHandler, type EntryPointType, type FileReader, Flare, type FlushFn, type FlushScheduler, type Framework, FrameworkName, GlobalScopeProvider, type Glow, InMemoryActiveSpanHolder, type KeyValue, Logger, type LoggerDeps, type LogsEnvelope, MAX_BREADCRUMB_URL_LENGTH, type MessageLevel, NoopFlushScheduler, NullFileReader, type OtelLogRecord, type OtelSpan, type OverriddenGrouping, type RejectionReporter, type Report, type SafeCloneOptions, type SamplingContext, Scope, type ScopeProvider, type SdkInfo, type SdkTaggable, type Span, type SpanEvent, type SpanLifecycleEvent, type SpanLifecycleListener, type SpanOptions, type SpanPhase, type SpanStatus, SpanStatusCode, type SpanTypeName, type StackFrame, Tracer, type TracerDeps, type TracesEnvelope, type TracesSampler, USER_IDENTITY_KEYS, type User, assert, assertKey, breadcrumbUrl, buildTraceparent, buildTracesEnvelope, convertToError, createIdentityTagger, createStackTrace, defaultNowNano, describeRejectionReason, extractCode, flatJsonStringify, getCodeSnippet, glowsToEvents, now, parseTraceparent, readLinesFromFile, recordBreadcrumb, redactObjectValues, redactUrlQuery, resolveDenylist, routeRejection, safeClone, safeDecode, spanId, toCustomContext, urlAttributes, userIdentityAttributes };
|
|
398
|
+
export { type ActiveSpanHolder, type AnyValue, Api, type AttributeValue, type Attributes, BrowserSpanEventType, BrowserSpanType, type BufferedLog, type BufferedSpan, type Config, type ContextCollector, DEFAULT_MAX_LIVE_TRACES, DEFAULT_URL_DENYLIST, type DeviceInfo, type DeviceInfoProvider, type EffectiveConnectionType, type EntryPointHandler, type EntryPointType, type FileReader, Flare, type FlushFn, type FlushScheduler, type Framework, FrameworkName, GlobalScopeProvider, type Glow, InMemoryActiveSpanHolder, type KeyValue, Logger, type LoggerDeps, type LogsEnvelope, MAX_BREADCRUMB_URL_LENGTH, type MessageLevel, NoopFlushScheduler, NullDeviceInfoProvider, NullFileReader, type OtelLogRecord, type OtelSpan, type OverriddenGrouping, type RejectionReporter, type Report, type SafeCloneOptions, type SamplingContext, Scope, type ScopeProvider, type SdkInfo, type SdkTaggable, type Span, type SpanEvent, type SpanLifecycleEvent, type SpanLifecycleListener, type SpanOptions, type SpanPhase, type SpanStatus, SpanStatusCode, type SpanTypeName, type StackFrame, Tracer, type TracerDeps, type TracesEnvelope, type TracesSampler, USER_IDENTITY_KEYS, type User, assert, assertKey, breadcrumbUrl, buildDeviceContextGroup, buildTraceparent, buildTracesEnvelope, convertToError, createIdentityTagger, createStackTrace, defaultNowNano, describeRejectionReason, deviceInfoToAttributes, evictLruIfNew, extractCode, flatJsonStringify, getCodeSnippet, glowsToEvents, now, parseTraceparent, readLinesFromFile, recordBreadcrumb, redactObjectValues, redactUrlQuery, resolveDenylist, routeRejection, safeClone, safeDecode, spanId, toCustomContext, urlAttributes, userIdentityAttributes };
|
package/dist/index.mjs
CHANGED
|
@@ -1,13 +1,13 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { A as KEY, C as createIdentityTagger, D as assertKey, O as assert, S as evictLruIfNew, _ as MAX_TRAVERSAL_DEPTH, a as describeRejectionReason, b as spendNode, c as redactObjectValues, d as safeDecode, f as now, g as safeClone, h as flatJsonStringify, i as setDefined, j as SOURCEMAP_VERSION, k as CLIENT_VERSION, l as redactUrlQuery, m as glowsToEvents, n as urlAttributes, o as routeRejection, p as timelineEvents, r as toCustomContext, s as DEFAULT_URL_DENYLIST, u as resolveDenylist, v as TRUNCATED, w as convertToError, x as extractCode, y as createTraversalBudget } from "./urlAttributes-ggdpIKSS.mjs";
|
|
2
2
|
import ErrorStackParser from "error-stack-parser";
|
|
3
3
|
|
|
4
4
|
//#region src/framework.ts
|
|
5
5
|
/**
|
|
6
|
-
* Framework names the Flare backend
|
|
7
|
-
* `flare.framework.name` and (lowercased) as `context.custom.framework`.
|
|
6
|
+
* Framework names the Flare backend recognizes. Wire format: these values never change, since they
|
|
7
|
+
* ship as `flare.framework.name` and (lowercased) as `context.custom.framework`.
|
|
8
8
|
*
|
|
9
|
-
* `Js` and `Node` are the base SDKs
|
|
10
|
-
* own name. `NodeElectron` is
|
|
9
|
+
* `Js` and `Node` are fallback claims from the base SDKs, overwritten when a framework package sets
|
|
10
|
+
* its own name. `NodeElectron` is the Electron main process; renderers report their own name.
|
|
11
11
|
*/
|
|
12
12
|
const FrameworkName = {
|
|
13
13
|
Js: "js",
|
|
@@ -23,7 +23,7 @@ const FrameworkName = {
|
|
|
23
23
|
//#endregion
|
|
24
24
|
//#region src/spanTypes.ts
|
|
25
25
|
/**
|
|
26
|
-
* Span types the Flare backend
|
|
26
|
+
* Span types the Flare backend recognizes. Wire format, so the values never change: they ship as the
|
|
27
27
|
* `flare.span_type` attribute and the backend groups performance data by them.
|
|
28
28
|
*
|
|
29
29
|
* These are the browser client's set. They live in core because core's `SpanOptions.spanType` needs
|
|
@@ -37,6 +37,10 @@ const BrowserSpanType = {
|
|
|
37
37
|
Component: "browser_component",
|
|
38
38
|
WebVital: "browser_web_vital"
|
|
39
39
|
};
|
|
40
|
+
/**
|
|
41
|
+
* Span event types on an error report. Kept apart from `BrowserSpanType`: these are points in time,
|
|
42
|
+
* not spans with a duration. That is also why a route change is not called `browser_navigation`.
|
|
43
|
+
*/
|
|
40
44
|
const BrowserSpanEventType = {
|
|
41
45
|
Click: "browser_click",
|
|
42
46
|
Input: "browser_input",
|
|
@@ -55,7 +59,6 @@ const SpanStatusCode = {
|
|
|
55
59
|
//#endregion
|
|
56
60
|
//#region src/util/utf8Bytes.ts
|
|
57
61
|
const textEncoder = new TextEncoder();
|
|
58
|
-
/** UTF-8 byte length of `value`. */
|
|
59
62
|
function utf8Bytes(value) {
|
|
60
63
|
return textEncoder.encode(value).length;
|
|
61
64
|
}
|
|
@@ -69,8 +72,7 @@ var Api = class {
|
|
|
69
72
|
pendingKeepaliveRequests = 0;
|
|
70
73
|
/**
|
|
71
74
|
* How many keepalive bytes are still available. Logs and traces share one browser allowance and both
|
|
72
|
-
* flush on page hide, so whichever goes second
|
|
73
|
-
* whole budget, or it exceeds the gate in send() and silently degrades to a cancellable fetch.
|
|
75
|
+
* flush on page hide, so whichever goes second must pack against what is left, not the whole budget.
|
|
74
76
|
*/
|
|
75
77
|
keepaliveBudgetRemaining() {
|
|
76
78
|
if (this.pendingKeepaliveRequests >= MAX_PENDING_KEEPALIVE_REQUESTS) return 0;
|
|
@@ -170,11 +172,6 @@ function recordBreadcrumb(scopeProvider, config, type, attributes, startTimeUnix
|
|
|
170
172
|
|
|
171
173
|
//#endregion
|
|
172
174
|
//#region src/telemetry/TelemetryBuffer.ts
|
|
173
|
-
/**
|
|
174
|
-
* The batching machine behind both telemetry signals: hold records, ship them when a size, weight or time
|
|
175
|
-
* trigger fires, and shed the oldest when nothing can drain. One instance owns one signal; what that signal
|
|
176
|
-
* is comes entirely from the policy.
|
|
177
|
-
*/
|
|
178
175
|
var TelemetryBuffer = class {
|
|
179
176
|
entries = [];
|
|
180
177
|
bufferedBytes = 0;
|
|
@@ -284,11 +281,6 @@ var TelemetryBuffer = class {
|
|
|
284
281
|
if (dropped) this.bufferedBytes -= dropped.bytes;
|
|
285
282
|
}
|
|
286
283
|
}
|
|
287
|
-
/**
|
|
288
|
-
* Newest-wins. An over-budget record is skipped, not a stop signal, so a smaller older record behind a fat
|
|
289
|
-
* one still ships. Runs on visibilitychange:hidden, which fires on plain backgrounding too, so the tail this
|
|
290
|
-
* leaves behind is retained and re-armed rather than dropped (see flush).
|
|
291
|
-
*/
|
|
292
284
|
packForKeepalive(config, resource) {
|
|
293
285
|
const fixedBytes = this.policy.emptyEnvelopeBytes(resource);
|
|
294
286
|
const budget = Math.min(config.keepaliveMaxBytes, this.policy.keepaliveBudget?.(config) ?? config.keepaliveMaxBytes);
|
|
@@ -317,11 +309,6 @@ var TelemetryBuffer = class {
|
|
|
317
309
|
|
|
318
310
|
//#endregion
|
|
319
311
|
//#region src/telemetry/resourceIdentity.ts
|
|
320
|
-
/**
|
|
321
|
-
* Builds the attributes that go on every logs or traces envelope: the caller's own attributes in `base`, with
|
|
322
|
-
* our SDK, service and framework identity on top. Our keys win, so a user value cannot overwrite something
|
|
323
|
-
* like `telemetry.sdk.name`.
|
|
324
|
-
*/
|
|
325
312
|
function buildResourceIdentity(base, config, sdk, framework) {
|
|
326
313
|
const identity = {
|
|
327
314
|
"telemetry.sdk.language": "javascript",
|
|
@@ -342,18 +329,6 @@ function buildResourceIdentity(base, config, sdk, framework) {
|
|
|
342
329
|
|
|
343
330
|
//#endregion
|
|
344
331
|
//#region src/logging/otel.ts
|
|
345
|
-
/**
|
|
346
|
-
* Converts one attribute value into the OpenTelemetry `AnyValue` shape. Strings, numbers and booleans become
|
|
347
|
-
* leaves, arrays and objects are walked recursively. Anything OpenTelemetry cannot carry (null, undefined,
|
|
348
|
-
* NaN, functions) returns null and the caller drops that key.
|
|
349
|
-
*
|
|
350
|
-
* A value that contains itself becomes the string `[Circular]`. `inPath` only holds the parents of the value
|
|
351
|
-
* being converted right now, so the same object used twice side by side is converted twice instead of being
|
|
352
|
-
* wrongly called circular.
|
|
353
|
-
*
|
|
354
|
-
* The walk also stops at a maximum depth and a maximum number of nodes, see traversalBudget.ts. Pass `budget`
|
|
355
|
-
* to let several calls share one allowance, otherwise every call gets its own.
|
|
356
|
-
*/
|
|
357
332
|
function valueToOpenTelemetry(value, inPath = /* @__PURE__ */ new WeakSet(), budget = createTraversalBudget()) {
|
|
358
333
|
return convert(value, inPath, 0, budget);
|
|
359
334
|
}
|
|
@@ -438,17 +413,9 @@ function buildLogsEnvelope(records, resourceAttributes, scopeName, scopeVersion)
|
|
|
438
413
|
}]
|
|
439
414
|
}] };
|
|
440
415
|
}
|
|
441
|
-
/**
|
|
442
|
-
* How many UTF-8 bytes one record adds to an envelope. We measure the real toOtelLogRecord output instead of
|
|
443
|
-
* reusing the cached BufferedLog estimate, because keepaliveMaxBytes is a hard browser limit and an estimate
|
|
444
|
-
* is not good enough.
|
|
445
|
-
*
|
|
446
|
-
* Uses flatJsonStringify to match Api.logs, which sends the envelope through the same encoder.
|
|
447
|
-
*/
|
|
448
416
|
function otelLogRecordBytes(record) {
|
|
449
417
|
return utf8Bytes(flatJsonStringify(toOtelLogRecord(record)));
|
|
450
418
|
}
|
|
451
|
-
/** UTF-8 bytes of an empty envelope: the fixed overhead every batch has, before any records are added. */
|
|
452
419
|
function emptyLogsEnvelopeBytes(resourceAttributes, scopeName, scopeVersion) {
|
|
453
420
|
return utf8Bytes(flatJsonStringify(buildLogsEnvelope([], resourceAttributes, scopeName, scopeVersion)));
|
|
454
421
|
}
|
|
@@ -589,6 +556,8 @@ const RESOURCE_PREFIXES = [
|
|
|
589
556
|
"host.",
|
|
590
557
|
"os.",
|
|
591
558
|
"process.",
|
|
559
|
+
"device.",
|
|
560
|
+
"network.",
|
|
592
561
|
"flare.framework.",
|
|
593
562
|
"flare.language."
|
|
594
563
|
];
|
|
@@ -606,7 +575,6 @@ function partitionAttributes(attributes) {
|
|
|
606
575
|
|
|
607
576
|
//#endregion
|
|
608
577
|
//#region src/Scope.ts
|
|
609
|
-
/** `USER_IDENTITY_KEYS` derives from this, so adding a field here can never leave the clear pass stale. */
|
|
610
578
|
const USER_FIELD_KEYS = {
|
|
611
579
|
id: "user.id",
|
|
612
580
|
email: "user.email",
|
|
@@ -786,11 +754,9 @@ function isApplicationFrame(fileName) {
|
|
|
786
754
|
//#endregion
|
|
787
755
|
//#region src/stacktrace/NullFileReader.ts
|
|
788
756
|
/**
|
|
789
|
-
* No-op `FileReader` returning `null` for every URL. Default for `Flare`'s `fileReader` param so
|
|
790
|
-
* reports without picking an environment; stack frames just omit source snippets.
|
|
791
|
-
*
|
|
792
|
-
* interface lets the stack-trace builder treat all three the same (render on text, skip on null), so core needs no
|
|
793
|
-
* environment checks.
|
|
757
|
+
* No-op `FileReader` returning `null` for every URL. Default for `Flare`'s `fileReader` param, so
|
|
758
|
+
* `new Flare()` builds reports without picking an environment; stack frames just omit source snippets.
|
|
759
|
+
* `@flareapp/js` and `@flareapp/node` inject a real fetch- or disk-based reader instead.
|
|
794
760
|
*/
|
|
795
761
|
var NullFileReader = class {
|
|
796
762
|
read(_url) {
|
|
@@ -976,28 +942,15 @@ function buildTracesEnvelope(spans, resourceAttributes, scopeName, scopeVersion)
|
|
|
976
942
|
}]
|
|
977
943
|
}] };
|
|
978
944
|
}
|
|
979
|
-
/**
|
|
980
|
-
* How many UTF-8 bytes one span adds to an envelope. We measure the real toOtelSpan output instead of reusing
|
|
981
|
-
* the cached BufferedSpan estimate, because keepaliveMaxBytes is a hard browser limit and an estimate is not
|
|
982
|
-
* good enough.
|
|
983
|
-
*
|
|
984
|
-
* We use flatJsonStringify instead of JSON.stringify because a span keeps values the caller still owns, like
|
|
985
|
-
* status.message, and those can turn unserializable after the span ended. This runs from a visibilitychange
|
|
986
|
-
* listener with no try/catch around it, so a throw here loses the flush. flatJsonStringify handles the usual
|
|
987
|
-
* suspects (circular references, BigInt, a getter that throws on a plain object) but is not bulletproof: a
|
|
988
|
-
* class instance with a throwing getter goes through untouched and can still throw.
|
|
989
|
-
*/
|
|
990
945
|
function otelSpanBytes(span) {
|
|
991
946
|
return utf8Bytes(flatJsonStringify(toOtelSpan(span)));
|
|
992
947
|
}
|
|
993
|
-
/** UTF-8 bytes of an empty envelope: the fixed overhead every batch has, before any spans are added. */
|
|
994
948
|
function emptyTracesEnvelopeBytes(resourceAttributes, scopeName, scopeVersion) {
|
|
995
949
|
return utf8Bytes(JSON.stringify(buildTracesEnvelope([], resourceAttributes, scopeName, scopeVersion)));
|
|
996
950
|
}
|
|
997
951
|
|
|
998
952
|
//#endregion
|
|
999
953
|
//#region src/tracing/SpanBuffer.ts
|
|
1000
|
-
/** The span half of the shared telemetry buffer: names the config keys, the envelope and the ingest call. */
|
|
1001
954
|
var SpanBuffer = class {
|
|
1002
955
|
inner;
|
|
1003
956
|
constructor(deps) {
|
|
@@ -1082,11 +1035,9 @@ function parseTraceparent(header) {
|
|
|
1082
1035
|
function isPromiseLike(value) {
|
|
1083
1036
|
return (typeof value === "object" || typeof value === "function") && value !== null && typeof value.then === "function";
|
|
1084
1037
|
}
|
|
1085
|
-
/** `SpanOptions.parent` is a structurally overlapping union; `isRecording` is what tells a real Span apart. */
|
|
1086
1038
|
function isSpan(parent) {
|
|
1087
1039
|
return "isRecording" in parent;
|
|
1088
1040
|
}
|
|
1089
|
-
/** A SpanImpl carries the epoch it was created under; a hand-stitched `{traceId, spanId}` parent does not. */
|
|
1090
1041
|
function hasEpoch(parent) {
|
|
1091
1042
|
return "epoch" in parent && typeof parent.epoch === "number";
|
|
1092
1043
|
}
|
|
@@ -1095,16 +1046,6 @@ function defaultNowNano() {
|
|
|
1095
1046
|
const ms = performanceApi && typeof performanceApi.now === "function" && typeof performanceApi.timeOrigin === "number" ? performanceApi.timeOrigin + performanceApi.now() : Date.now();
|
|
1096
1047
|
return Math.round(ms * 1e6);
|
|
1097
1048
|
}
|
|
1098
|
-
/**
|
|
1099
|
-
* Both trace maps cap their size the same way: insertion order is LRU, so the first key is the one to drop.
|
|
1100
|
-
* Only evicts when `key` is not already in the map. A set() that overwrites an existing key does not grow the
|
|
1101
|
-
* map, so it must not evict an unrelated entry to make room for it.
|
|
1102
|
-
*/
|
|
1103
|
-
function evictLruIfNew(map, key, cap) {
|
|
1104
|
-
if (map.has(key) || map.size < cap) return;
|
|
1105
|
-
const lru = map.keys().next().value;
|
|
1106
|
-
if (lru !== void 0) map.delete(lru);
|
|
1107
|
-
}
|
|
1108
1049
|
const MAX_CLOSED_TRACES = 100;
|
|
1109
1050
|
/** Bounded backstop for the live TraceState map: an app that never ends spans must not grow it forever. */
|
|
1110
1051
|
const DEFAULT_MAX_LIVE_TRACES = 1e3;
|
|
@@ -1143,10 +1084,9 @@ var Tracer = class {
|
|
|
1143
1084
|
this.holder.setActiveRoot?.(span);
|
|
1144
1085
|
}
|
|
1145
1086
|
/**
|
|
1146
|
-
*
|
|
1147
|
-
*
|
|
1148
|
-
*
|
|
1149
|
-
* Consumed by the matching `startSpan({ claimed: true })`.
|
|
1087
|
+
* Claims a span slot before the span exists, for a caller that publishes a span id early (the
|
|
1088
|
+
* component profilers do; their descendants record first). Returns false when the trace is full.
|
|
1089
|
+
* Paired with `startSpan({ claimed: true })`.
|
|
1150
1090
|
*/
|
|
1151
1091
|
claimSpanSlot(traceId) {
|
|
1152
1092
|
const config = this.deps.getConfig();
|
|
@@ -1185,7 +1125,7 @@ var Tracer = class {
|
|
|
1185
1125
|
this.pendingContinuation = parseTraceparent(header);
|
|
1186
1126
|
}
|
|
1187
1127
|
/**
|
|
1188
|
-
* Runs `fn` with the span active, so spans started inside auto-parent to it, then ends
|
|
1128
|
+
* Runs `fn` with the span active, so spans started inside it auto-parent to it, then ends the span.
|
|
1189
1129
|
* Records an error status first if `fn` throws or its returned promise rejects.
|
|
1190
1130
|
*/
|
|
1191
1131
|
withSpan(name, fn, opts = {}) {
|
|
@@ -1215,8 +1155,10 @@ var Tracer = class {
|
|
|
1215
1155
|
}
|
|
1216
1156
|
});
|
|
1217
1157
|
}
|
|
1218
|
-
/**
|
|
1219
|
-
*
|
|
1158
|
+
/**
|
|
1159
|
+
* Starts a span the caller must end. Unlike `withSpan`, it does not become the active span, so spans
|
|
1160
|
+
* started after it do not auto-parent to it.
|
|
1161
|
+
*/
|
|
1220
1162
|
startSpan(name, opts = {}) {
|
|
1221
1163
|
const config = this.deps.getConfig();
|
|
1222
1164
|
const spanId$1 = opts.spanId ?? spanId();
|
|
@@ -1246,7 +1188,6 @@ var Tracer = class {
|
|
|
1246
1188
|
this.emitSpanEvent("start", span);
|
|
1247
1189
|
return span;
|
|
1248
1190
|
}
|
|
1249
|
-
/** A real Span handle that records nothing, so callers never have to branch on whether tracing is on. */
|
|
1250
1191
|
startInertSpan(name, spanId, opts, config) {
|
|
1251
1192
|
const span = this.makeSpan({
|
|
1252
1193
|
traceId: traceId(),
|
|
@@ -1353,7 +1294,6 @@ var Tracer = class {
|
|
|
1353
1294
|
if (opts.attributes) for (const [key, value] of Object.entries(opts.attributes)) span.setAttribute(key, value);
|
|
1354
1295
|
return span;
|
|
1355
1296
|
}
|
|
1356
|
-
/** Bounded, LRU by insertion order, like traceStates. Holds primitives only, never a span. */
|
|
1357
1297
|
rememberClosed(state) {
|
|
1358
1298
|
evictLruIfNew(this.closedTraces, state.traceId, MAX_CLOSED_TRACES);
|
|
1359
1299
|
this.closedTraces.set(state.traceId, {
|
|
@@ -1408,8 +1348,6 @@ var Tracer = class {
|
|
|
1408
1348
|
|
|
1409
1349
|
//#endregion
|
|
1410
1350
|
//#region src/Flare.ts
|
|
1411
|
-
/** Scope attributes a span never inherits. Derived from `USER_IDENTITY_KEYS` so a future user field is
|
|
1412
|
-
* excluded automatically, without anyone needing to remember to list it here. See `getScopeAttributes`. */
|
|
1413
1351
|
const SPAN_SCOPE_EXCLUDED_KEYS = USER_IDENTITY_KEYS.filter((key) => key !== USER_FIELD_KEYS.id);
|
|
1414
1352
|
const DEFAULT_SDK_NAME = "@flareapp/core";
|
|
1415
1353
|
var Flare = class {
|
|
@@ -1494,14 +1432,6 @@ var Flare = class {
|
|
|
1494
1432
|
activeSpanHolder
|
|
1495
1433
|
});
|
|
1496
1434
|
}
|
|
1497
|
-
/**
|
|
1498
|
-
* Register an in-flight report so `flush()` can wait for it. Every entry point wraps its whole async
|
|
1499
|
-
* pipeline, from beforeEvaluate through api.report, so flush() waits on all of it.
|
|
1500
|
-
*
|
|
1501
|
-
* What goes in the Set is a shadow promise that mirrors `p`'s timing but cannot reject, so a failed
|
|
1502
|
-
* report never surfaces as an unhandled rejection warning. `p` itself is returned untouched, so the
|
|
1503
|
-
* caller still observes real success or failure.
|
|
1504
|
-
*/
|
|
1505
1435
|
track(p) {
|
|
1506
1436
|
const tracked = p.then(() => void 0, () => void 0);
|
|
1507
1437
|
this.inflight.add(tracked);
|
|
@@ -1509,12 +1439,11 @@ var Flare = class {
|
|
|
1509
1439
|
return p;
|
|
1510
1440
|
}
|
|
1511
1441
|
/**
|
|
1512
|
-
*
|
|
1513
|
-
*
|
|
1514
|
-
* drain any other concurrent reports before `process.exit`.
|
|
1442
|
+
* Waits until every in-flight report settles, or `timeoutMs` elapses. Always resolves, never rejects.
|
|
1443
|
+
* Used by `@flareapp/node`'s fatal handler to drain other reports before `process.exit`.
|
|
1515
1444
|
*
|
|
1516
|
-
*
|
|
1517
|
-
*
|
|
1445
|
+
* Only reports already in flight are awaited, so a handler still emitting during shutdown cannot block
|
|
1446
|
+
* forever. Call flush again to catch those.
|
|
1518
1447
|
*/
|
|
1519
1448
|
flush(timeoutMs = 2e3) {
|
|
1520
1449
|
this._logger.flush();
|
|
@@ -1661,10 +1590,6 @@ var Flare = class {
|
|
|
1661
1590
|
this.framework = framework;
|
|
1662
1591
|
return this;
|
|
1663
1592
|
}
|
|
1664
|
-
/**
|
|
1665
|
-
* True when a report must not be captured: consent withdrawn, or dropped by sampling. Consent is
|
|
1666
|
-
* checked first, so a blocked report never runs the sampler or assembles a report (no cookie read).
|
|
1667
|
-
*/
|
|
1668
1593
|
shouldSkipCapture() {
|
|
1669
1594
|
if (this._config.hasConsent === false) return true;
|
|
1670
1595
|
return this._config.sampleRate < 1 && Math.random() >= this._config.sampleRate;
|
|
@@ -1789,15 +1714,6 @@ var Flare = class {
|
|
|
1789
1714
|
record: this.assembleAttributes(collectorRecord, userAttributes, false)
|
|
1790
1715
|
};
|
|
1791
1716
|
}
|
|
1792
|
-
/**
|
|
1793
|
-
* Local roots only, snapshotted by the Tracer at span START so a long-lived root does not drift into
|
|
1794
|
-
* the next page's scope. Children get none, and no span ever runs the DOM collector.
|
|
1795
|
-
*
|
|
1796
|
-
* Everything assembled is inherited except user identity (excluding the opaque `user.id`): a root span
|
|
1797
|
-
* goes out for every page view, so email, full name, IP and `user.attributes` would turn normal
|
|
1798
|
-
* browsing into PII traffic. The rest — `context.custom`, `addContextGroup` bags — stays in, because
|
|
1799
|
-
* the trace viewer renders any span attribute whose key does not start with `flare.`.
|
|
1800
|
-
*/
|
|
1801
1717
|
getScopeAttributes() {
|
|
1802
1718
|
const scoped = { ...this.assembleAttributes({}, {}, false) };
|
|
1803
1719
|
for (const key of SPAN_SCOPE_EXCLUDED_KEYS) delete scoped[key];
|
|
@@ -1833,4 +1749,71 @@ var Flare = class {
|
|
|
1833
1749
|
};
|
|
1834
1750
|
|
|
1835
1751
|
//#endregion
|
|
1836
|
-
|
|
1752
|
+
//#region src/device/DeviceInfoProvider.ts
|
|
1753
|
+
/** Default for platforms with no device info. */
|
|
1754
|
+
var NullDeviceInfoProvider = class {
|
|
1755
|
+
collect() {
|
|
1756
|
+
return {};
|
|
1757
|
+
}
|
|
1758
|
+
};
|
|
1759
|
+
|
|
1760
|
+
//#endregion
|
|
1761
|
+
//#region src/device/deviceInfoToAttributes.ts
|
|
1762
|
+
/** Map `DeviceInfo` to wire attributes: flat keys plus a `context.device` card. Shared by every SDK, so keys never drift. */
|
|
1763
|
+
function deviceInfoToAttributes(info) {
|
|
1764
|
+
const attrs = {};
|
|
1765
|
+
setDefined(attrs, "os.name", info.os?.name);
|
|
1766
|
+
setDefined(attrs, "os.version", info.os?.version);
|
|
1767
|
+
setDefined(attrs, "process.runtime.name", info.runtime?.name);
|
|
1768
|
+
setDefined(attrs, "process.runtime.version", info.runtime?.version);
|
|
1769
|
+
setDefined(attrs, "device.type", info.device?.type);
|
|
1770
|
+
setDefined(attrs, "device.model.name", info.device?.model);
|
|
1771
|
+
setDefined(attrs, "device.memory_gb", info.device?.memoryGb);
|
|
1772
|
+
setDefined(attrs, "device.cpu_cores", info.device?.cpuCores);
|
|
1773
|
+
setDefined(attrs, "device.screen.width", info.device?.screen?.width);
|
|
1774
|
+
setDefined(attrs, "device.screen.height", info.device?.screen?.height);
|
|
1775
|
+
setDefined(attrs, "device.screen.scale", info.device?.screen?.scale);
|
|
1776
|
+
setDefined(attrs, "network.effective_type", info.network?.effectiveType);
|
|
1777
|
+
setDefined(attrs, "network.downlink_mbps", info.network?.downlinkMbps);
|
|
1778
|
+
setDefined(attrs, "network.rtt_ms", info.network?.rttMs);
|
|
1779
|
+
setDefined(attrs, "network.online", info.network?.online);
|
|
1780
|
+
setDefined(attrs, "app.version", info.app?.version);
|
|
1781
|
+
setDefined(attrs, "app.id", info.app?.id);
|
|
1782
|
+
const group = buildDeviceContextGroup(info);
|
|
1783
|
+
if (Object.keys(group).length > 0) attrs["context.device"] = group;
|
|
1784
|
+
return attrs;
|
|
1785
|
+
}
|
|
1786
|
+
/**
|
|
1787
|
+
* `context.device` card for the error UI. Rendered one level deep, so values stay scalar. Built only when
|
|
1788
|
+
* a device or network signal exists (an os-only Node report gets none).
|
|
1789
|
+
*/
|
|
1790
|
+
function buildDeviceContextGroup(info) {
|
|
1791
|
+
if (!hasDeviceSignal(info.device) && !hasNetworkSignal(info.network)) return {};
|
|
1792
|
+
const group = {};
|
|
1793
|
+
const os = [info.os?.name, info.os?.version].filter((value) => value != null).join(" ");
|
|
1794
|
+
if (os) group.OS = os;
|
|
1795
|
+
setDefined(group, "Model", info.device?.model);
|
|
1796
|
+
setDefined(group, "Type", info.device?.type);
|
|
1797
|
+
const screen = info.device?.screen;
|
|
1798
|
+
if (screen?.width != null && screen?.height != null) group.Screen = screen.scale != null ? `${screen.width} × ${screen.height} @ ${screen.scale}x` : `${screen.width} × ${screen.height}`;
|
|
1799
|
+
if (info.device?.memoryGb != null) group.Memory = `${info.device.memoryGb} GB`;
|
|
1800
|
+
setDefined(group, "CPU cores", info.device?.cpuCores);
|
|
1801
|
+
setDefined(group, "Connection", info.network?.effectiveType);
|
|
1802
|
+
if (info.network?.downlinkMbps != null) group.Downlink = `${info.network.downlinkMbps} Mbps`;
|
|
1803
|
+
if (info.network?.rttMs != null) group.RTT = `${info.network.rttMs} ms`;
|
|
1804
|
+
setDefined(group, "Online", info.network?.online);
|
|
1805
|
+
setDefined(group, "App version", info.app?.version);
|
|
1806
|
+
setDefined(group, "App ID", info.app?.id);
|
|
1807
|
+
setDefined(group, "Language", info.locale?.language);
|
|
1808
|
+
setDefined(group, "Timezone", info.locale?.timezone);
|
|
1809
|
+
return group;
|
|
1810
|
+
}
|
|
1811
|
+
function hasDeviceSignal(device) {
|
|
1812
|
+
return device != null && (device.type != null || device.model != null || device.memoryGb != null || device.cpuCores != null || device.screen?.width != null || device.screen?.height != null);
|
|
1813
|
+
}
|
|
1814
|
+
function hasNetworkSignal(network) {
|
|
1815
|
+
return network != null && (network.effectiveType != null || network.downlinkMbps != null || network.rttMs != null || network.online != null);
|
|
1816
|
+
}
|
|
1817
|
+
|
|
1818
|
+
//#endregion
|
|
1819
|
+
export { Api, BrowserSpanEventType, BrowserSpanType, DEFAULT_MAX_LIVE_TRACES, DEFAULT_URL_DENYLIST, Flare, FrameworkName, GlobalScopeProvider, InMemoryActiveSpanHolder, Logger, MAX_BREADCRUMB_URL_LENGTH, NoopFlushScheduler, NullDeviceInfoProvider, NullFileReader, Scope, SpanStatusCode, Tracer, USER_IDENTITY_KEYS, assert, assertKey, breadcrumbUrl, buildDeviceContextGroup, buildTraceparent, buildTracesEnvelope, convertToError, createIdentityTagger, createStackTrace, defaultNowNano, describeRejectionReason, deviceInfoToAttributes, evictLruIfNew, extractCode, flatJsonStringify, getCodeSnippet, glowsToEvents, now, parseTraceparent, readLinesFromFile, recordBreadcrumb, redactObjectValues, redactUrlQuery, resolveDenylist, routeRejection, safeClone, safeDecode, spanId, toCustomContext, urlAttributes, userIdentityAttributes };
|