@copilotkit/runtime/dist/v2/runtime/telemetry/telemetry-client.mjs.map

<img src="https://github.com/user-attachments/assets/0a6b64d9-e193-4940-a3f6-60334ac34084" alt="banner" style="border-radius: 12px; border: 2px solid #d6d4fa;" />

{"version":3,"file":"telemetry-client.mjs","names":["isTelemetryDisabled","TelemetryClient","packageJson"],"sources":["../../../../src/v2/runtime/telemetry/telemetry-client.ts"],"sourcesContent":["import type { AnalyticsEvents } from \"./events\";\nimport { lambdaClient, parseAndWarnTelemetryId } from \"@copilotkit/shared\";\nimport * as packageJson from \"../../../../package.json\";\n\nexport function isTelemetryDisabled(): boolean {\n  return (\n    (process.env as Record<string, string | undefined>)\n      .COPILOTKIT_TELEMETRY_DISABLED === \"true\" ||\n    (process.env as Record<string, string | undefined>)\n      .COPILOTKIT_TELEMETRY_DISABLED === \"1\" ||\n    (process.env as Record<string, string | undefined>).DO_NOT_TRACK ===\n      \"true\" ||\n    (process.env as Record<string, string | undefined>).DO_NOT_TRACK === \"1\"\n  );\n}\n\nexport class TelemetryClient {\n  private telemetryDisabled: boolean = false;\n  // Client-side sampling rate for anonymous events. Identified callers\n  // (license token with telemetry_id) bypass the gate. Default 0.05\n  // caps anonymous OSS-runtime egress; identified customers send at\n  // full fidelity. Override via COPILOTKIT_TELEMETRY_SAMPLE_RATE.\n  private sampleRate: number = 0.05;\n  // EIP / Intelligence license token (Ed25519-signed JWT). The lambda\n  // client decodes its payload to read telemetry_id for the\n  // X-CopilotKit-Telemetry-Id header. Set once at runtime construction\n  // via setLicenseToken; absent values produce anonymous sends.\n  private licenseToken: string | null = null;\n  // Parsed telemetry_id from the license-token JWT payload. Cached at\n  // setLicenseToken time so `capture()` can branch on identified vs\n  // anonymous without re-parsing per event. Null when the token is\n  // absent or yielded no telemetry_id.\n  private telemetryId: string | null = null;\n  // Properties merged into every event this client sends.\n  //\n  // For facts about the caller that are true for the whole process rather than\n  // for one event: which product is embedding the runtime, for instance. A\n  // distribution built on top of this can then be told apart in the existing\n  // events instead of sending its own, which is the difference between one\n  // extra field and a second pipeline nobody asked for.\n  //\n  // Sent as `global_properties`, a field of its own, so these stay separable\n  // from an event's own properties all the way to the sink.\n  //\n  // Do not reuse a key an event already sets: the fanout spreads this bag last\n  // for `oss.runtime.*`, so a collision resolves in favour of the global and\n  // does so silently. Names here should describe the caller, not the call.\n  private globalProperties: Record<string, unknown> = {};\n\n  constructor({\n    telemetryDisabled,\n    sampleRate,\n  }: {\n    telemetryDisabled?: boolean;\n    sampleRate?: number;\n  } = {}) {\n    this.telemetryDisabled = telemetryDisabled ?? isTelemetryDisabled();\n    this.setSampleRate(sampleRate);\n  }\n\n  private shouldSendEvent() {\n    if (this.sampleRate >= 1) return true;\n    return Math.random() < this.sampleRate;\n  }\n\n  /**\n   * Add properties carried by every subsequent event.\n   *\n   * Merged rather than replaced, so two callers setting different fields do not\n   * erase each other. Set once at runtime construction in practice; nothing\n   * here is per-request.\n   */\n  setGlobalProperties(properties: Record<string, unknown>) {\n    this.globalProperties = { ...this.globalProperties, ...properties };\n  }\n\n  setLicenseToken(licenseToken: string) {\n    this.licenseToken = licenseToken;\n    this.telemetryId = parseAndWarnTelemetryId(licenseToken);\n  }\n\n  async capture<K extends keyof AnalyticsEvents>(\n    event: K,\n    properties: AnalyticsEvents[K],\n  ) {\n    if (this.telemetryDisabled) return;\n    // Anonymous callers are gated by sampleRate; identified callers\n    // (telemetry_id present) bypass the gate and always send.\n    if (!this.telemetryId && !this.shouldSendEvent()) return;\n\n    await lambdaClient.send({\n      event,\n      properties: properties as Record<string, unknown>,\n      // Its own field on the wire rather than folded into `properties`, which\n      // is what the sink expects: for `oss.runtime.*` the fanout treats\n      // `global_properties` as the SDK's pass-through bag and spreads it into\n      // the analytics event, and v1's client sends package name and version the\n      // same way. Folding it in would work and would put a process-level fact\n      // in the per-event slot, where nothing downstream expects to find one.\n      globalProperties: this.globalProperties,\n      packageName: packageJson.name,\n      packageVersion: packageJson.version,\n      licenseToken: this.licenseToken ?? undefined,\n    });\n  }\n\n  private setSampleRate(sampleRate: number | undefined) {\n    let _sampleRate: number;\n\n    _sampleRate = sampleRate ?? 0.05;\n\n    if (process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE) {\n      _sampleRate = parseFloat(process.env.COPILOTKIT_TELEMETRY_SAMPLE_RATE);\n    }\n\n    // Number.isNaN guards against parseFloat(\"nonsense\") slipping past the\n    // range check (all NaN comparisons are false), which would silently\n    // drop every anonymous event with no signal.\n    if (Number.isNaN(_sampleRate) || _sampleRate < 0 || _sampleRate > 1) {\n      throw new Error(\"Sample rate must be between 0 and 1\");\n    }\n\n    this.sampleRate = _sampleRate;\n  }\n}\n\nconst telemetry = new TelemetryClient();\nexport default telemetry;\n"],"mappings":";;;;;;;AAIA,SAAgBA,wBAA+B;AAC7C,QACG,QAAQ,IACN,kCAAkC,UACpC,QAAQ,IACN,kCAAkC,OACpC,QAAQ,IAA2C,iBAClD,UACD,QAAQ,IAA2C,iBAAiB;;AAIzE,IAAaC,oBAAb,MAA6B;CAiC3B,YAAY,EACV,mBACA,eAIE,EAAE,EAAE;2BAtC6B;oBAKR;sBAKS;qBAKD;0BAee,EAAE;AASpD,OAAK,oBAAoB,qBAAqBD,uBAAqB;AACnE,OAAK,cAAc,WAAW;;CAGhC,AAAQ,kBAAkB;AACxB,MAAI,KAAK,cAAc,EAAG,QAAO;AACjC,SAAO,KAAK,QAAQ,GAAG,KAAK;;;;;;;;;CAU9B,oBAAoB,YAAqC;AACvD,OAAK,mBAAmB;GAAE,GAAG,KAAK;GAAkB,GAAG;GAAY;;CAGrE,gBAAgB,cAAsB;AACpC,OAAK,eAAe;AACpB,OAAK,cAAc,wBAAwB,aAAa;;CAG1D,MAAM,QACJ,OACA,YACA;AACA,MAAI,KAAK,kBAAmB;AAG5B,MAAI,CAAC,KAAK,eAAe,CAAC,KAAK,iBAAiB,CAAE;AAElD,QAAM,aAAa,KAAK;GACtB;GACY;GAOZ,kBAAkB,KAAK;GACvB,aAAaE,eAAY;GACzB,gBAAgBA,eAAY;GAC5B,cAAc,KAAK,gBAAgB;GACpC,CAAC;;CAGJ,AAAQ,cAAc,YAAgC;EACpD,IAAI;AAEJ,gBAAc,cAAc;AAE5B,MAAI,QAAQ,IAAI,iCACd,eAAc,WAAW,QAAQ,IAAI,iCAAiC;AAMxE,MAAI,OAAO,MAAM,YAAY,IAAI,cAAc,KAAK,cAAc,EAChE,OAAM,IAAI,MAAM,sCAAsC;AAGxD,OAAK,aAAa;;;AAItB,MAAM,YAAY,IAAID,mBAAiB"}