File size: 3,601 Bytes
4e23b01 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 | import { arch, platform, release } from 'node:os';
import type {
EnrichedTelemetryEvent,
TelemetryContext,
TelemetryEvent,
TelemetryPrimitive,
TelemetryTransport,
} from './types';
export interface EventSinkContextOptions {
readonly appName: string;
readonly version: string;
readonly uiMode?: string;
readonly model?: string;
readonly buildSha?: string;
readonly terminal?: string;
readonly locale?: string;
readonly env?: NodeJS.ProcessEnv;
}
export interface EventSinkOptions {
readonly transport: TelemetryTransport;
readonly context: EventSinkContextOptions;
readonly flushIntervalMs?: number;
readonly flushThreshold?: number;
}
const DEFAULT_FLUSH_INTERVAL_MS = 30_000;
const DEFAULT_FLUSH_THRESHOLD = 50;
export class EventSink {
private readonly transport: TelemetryTransport;
private readonly context: TelemetryContext;
private readonly flushIntervalMs: number;
private readonly flushThreshold: number;
private buffer: EnrichedTelemetryEvent[] = [];
private flushTimer: ReturnType<typeof setInterval> | null = null;
constructor(options: EventSinkOptions) {
this.transport = options.transport;
this.context = buildContext(options.context);
this.flushIntervalMs = options.flushIntervalMs ?? DEFAULT_FLUSH_INTERVAL_MS;
this.flushThreshold = options.flushThreshold ?? DEFAULT_FLUSH_THRESHOLD;
}
accept(event: TelemetryEvent): void {
const enriched: EnrichedTelemetryEvent = {
...event,
context: { ...this.context },
};
this.buffer.push(enriched);
if (this.buffer.length >= this.flushThreshold) {
void this.flush().catch(() => {});
}
}
setModel(model: string): void {
setPrimitive(this.context, 'model', model);
}
startPeriodicFlush(): void {
if (this.flushTimer !== null) return;
this.flushTimer = setInterval(() => {
void this.flush().catch(() => {});
}, this.flushIntervalMs);
this.flushTimer.unref?.();
}
stopPeriodicFlush(): void {
if (this.flushTimer === null) return;
clearInterval(this.flushTimer);
this.flushTimer = null;
}
async retryDiskEvents(): Promise<void> {
await this.transport.retryDiskEvents();
}
clearBuffer(): void {
this.buffer = [];
}
async flush(signal?: AbortSignal): Promise<void> {
if (this.buffer.length === 0) return;
const events = this.buffer;
this.buffer = [];
await this.transport.send(events, signal);
}
flushSync(): void {
if (this.buffer.length === 0) return;
const events = this.buffer;
this.buffer = [];
try {
this.transport.saveToDisk(events);
} catch {
// Telemetry must never make shutdown fail.
}
}
}
function buildContext(options: EventSinkContextOptions): TelemetryContext {
const env = options.env ?? process.env;
const context: TelemetryContext = {
app_name: options.appName,
version: options.version,
runtime: 'node',
platform: platform(),
arch: arch(),
node_version: process.versions.node,
os_version: release(),
ci: env['CI'] !== undefined,
locale: options.locale ?? env['LANG'] ?? '',
terminal: options.terminal ?? env['TERM_PROGRAM'] ?? '',
ui_mode: options.uiMode ?? 'shell',
};
setPrimitive(context, 'model', options.model);
setPrimitive(context, 'build_sha', options.buildSha);
return context;
}
function setPrimitive(
target: TelemetryContext,
key: string,
value: TelemetryPrimitive | undefined,
): void {
if (value === undefined) return;
if (typeof value === 'string' && value.length === 0) return;
target[key] = value;
}
|