Class TelemetryClient

packages/telemetry/src/client.ts:25–148

}

export class TelemetryClient {
  private queue: PendingTelemetryEvent[] = [];
  private sink: EventSink | null = null;
  private deviceId: string | null = null;
  private sessionId: string | null = null;
  private disabled = false;

  setContext(input: TelemetryContextIds): void {
    if (input.deviceId !== undefined) this.deviceId = input.deviceId;
    if (input.sessionId !== undefined) this.sessionId = input.sessionId;
  }

  withContext(input: TelemetryContextIds): TelemetryClient {
    return new ScopedTelemetryClient(this, input);
  }

  attachSink(sink: EventSink): void {
    if (this.sink !== null && this.sink !== sink) {
      this.sink.stopPeriodicFlush();
      this.sink.flushSync();
    }
    this.sink = sink;
    for (const event of this.queue) {
      const record = toTelemetryEvent(event);
      if (record.device_id === null && event.contextOverrides?.deviceId !== true) {
        record.device_id = this.deviceId;
      }
      if (record.session_id === null && event.contextOverrides?.sessionId !== true) {
        record.session_id = this.sessionId;
      }
      sink.accept(record);
    }
    this.queue = [];
  }

  disable(): void {
    this.disabled = true;
    this.queue = [];
    if (this.sink !== null) {
      this.sink.stopPeriodicFlush();
      this.sink.clearBuffer();
      this.sink = null;
    }
  }

  enable(): void {
    this.disabled = false;
  }

  track(event: string, properties: TelemetryProperties = {}): void {
    this.trackWithContext(event, properties, {});
  }

  trackWithContext(
    event: string,
    properties: TelemetryProperties = {},
    context: TelemetryContextIds,
  ): void {