Add support for telemetry debugging via VERCEL_TELEMETRY_DEBUG

jeffsee55 · jeffsee55 · commit 64acfdd46b23 · 2024-10-02T13:01:41.000-07:00
diff --git a/.changeset/thirty-seahorses-watch.md b/.changeset/thirty-seahorses-watch.md
@@ -0,0 +1,5 @@
+---
+'vercel': patch
+---
+
+Add support for telemetry debugging via VERCEL_TELEMETRY_DEBUG. Telemetry collection is not currently enabled and when it is, will be a major version bump for the CLI.
diff --git a/packages/cli/src/index.ts b/packages/cli/src/index.ts
@@ -114,7 +114,7 @@ const main = async () => {
   });
 
   const telemetryEventStore = new TelemetryEventStore({
-    isDebug: isDebugging,
+    isDebug: process.env.VERCEL_TELEMETRY_DEBUG === '1',
     output,
   });
 
diff --git a/packages/cli/src/util/telemetry/index.ts b/packages/cli/src/util/telemetry/index.ts
@@ -102,6 +102,8 @@ export class TelemetryClient {
 export class TelemetryEventStore {
   private events: Event[];
   private output: Output;
+  // Whether to log telemetry events to the console, this behavior is independent of the `--debug` flag
+  // which is used to enable debug logging for the CLI as a whole.
   private isDebug: boolean;
   private sessionId: string;
 
@@ -127,9 +129,11 @@ export class TelemetryEventStore {
 
   save() {
     if (this.isDebug) {
-      this.output.debug(`${LogLabel} Flushing Events`);
+      // Intentionally not using `this.output.debug` as it will
+      // not write to stderr unless the is run with `--debug`
+      this.output.log(`${LogLabel} Flushing Events`);
       this.events.forEach(event => {
-        this.output.debug(JSON.stringify(event));
+        this.output.log(JSON.stringify(event));
       });
     }
   }

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'vercel': patch
 +---
++
 +Add support for telemetry debugging via VERCEL_TELEMETRY_DEBUG. Telemetry collection is not currently enabled and when it is, will be a major version bump for the CLI.