@salesforce/telemetry 6.7.2 → 6.8.0

package/README.md

@@ -44,6 +44,14 @@ reporter.sendTelemetryEvent('event-name', { foo: 'bar', executionTime: 0.5912 })
 reporter.stop();
 ```
 
+To ensure all buffered events are flushed before process exit (e.g. when using O11y batching), use `stopAsync()`:
+
+```javascript
+// Await shutdown so all events are sent before exiting
+await reporter.stopAsync();
+process.exit(0);
+```
+
 **Note:** For short lived processes, the telemetry can take 0-3 seconds to send all events to the server on stop, and even longer if there is a timeout. It is recommended to send telemetry in a detached spawned process. i.e. `spawn(..., { stdio: 'ignore'}).unref();`
 
 ### O11y (Observability) Telemetry
@@ -159,6 +167,14 @@ You can also manually flush buffered events when needed (e.g., before critical o
 await reporter.flush();
 ```
 
+For graceful shutdown that stops the batching interval and flushes all events, use `stopAsync()`:
+
+```javascript
+// Stop batching, flush remaining events, and dispose
+await reporter.stopAsync();
+process.exit(0);
+```
+
 **Note:** When batching is disabled, events are uploaded immediately after each `sendTelemetryEvent()`, `sendTelemetryException()`, `sendTelemetryTrace()`, or `sendTelemetryMetric()` call for backward compatibility.
 
 ## Env Variables

package/lib/o11yReporter.d.ts

@@ -58,6 +58,17 @@ export declare class O11yReporter extends BaseReporter {
      */
     sendPdpEvent(event: PdpEvent): Promise<void>;
     flush(): Promise<void>;
+    /**
+     * Stop batching (if enabled), flush any remaining events, and clean up.
+     * Call this before process exit to ensure all events are sent and timers are cleared.
+     *
+     * @example
+     * ```typescript
+     * await reporter.stop();
+     * process.exit(0);
+     * ```
+     */
+    stop(): Promise<void>;
     /**
      * Publishes exception to O11y service
      *

package/lib/o11yReporter.js

@@ -138,6 +138,25 @@ class O11yReporter extends baseReporter_1.BaseReporter {
         // Use forceFlush for explicit manual flush
         await this.service.forceFlush();
     }
+    /**
+     * Stop batching (if enabled), flush any remaining events, and clean up.
+     * Call this before process exit to ensure all events are sent and timers are cleared.
+     *
+     * @example
+     * ```typescript
+     * await reporter.stop();
+     * process.exit(0);
+     * ```
+     */
+    async stop() {
+        await this.initialized;
+        if (this._batchingCleanup) {
+            this._batchingCleanup();
+            this._batchingCleanup = null;
+            this._batchingEnabled = false;
+        }
+        await this.service.forceFlush();
+    }
     /**
      * Publishes exception to O11y service
      *

package/lib/telemetryReporter.d.ts

@@ -32,6 +32,17 @@ export declare class TelemetryReporter extends AsyncCreatable<TelemetryOptions>
      * not counting timeouts.
      */
     stop(): void;
+    /**
+     * Async version of stop() that awaits O11y cleanup (batching interval stop + flush).
+     * Use this when you need to ensure telemetry is fully shut down before process exit.
+     *
+     * @example
+     * ```typescript
+     * await reporter.stopAsync();
+     * process.exit(0);
+     * ```
+     */
+    stopAsync(): Promise<void>;
     waitForConnection(): Promise<void>;
     testConnection(): Promise<boolean>;
     /**

package/lib/telemetryReporter.js

@@ -150,7 +150,21 @@ class TelemetryReporter extends kit_1.AsyncCreatable {
      */
     stop() {
         this.reporter?.stop();
-        void this.o11yReporter?.flush();
+        void this.o11yReporter?.stop();
+    }
+    /**
+     * Async version of stop() that awaits O11y cleanup (batching interval stop + flush).
+     * Use this when you need to ensure telemetry is fully shut down before process exit.
+     *
+     * @example
+     * ```typescript
+     * await reporter.stopAsync();
+     * process.exit(0);
+     * ```
+     */
+    async stopAsync() {
+        this.reporter?.stop();
+        await this.o11yReporter?.stop();
     }
     async waitForConnection() {
         const canConnect = await this.testConnection();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@salesforce/telemetry",
-  "version": "6.7.2",
+  "version": "6.8.0",
   "description": "Library for telemetry reporting to Application Insights and O11y",
   "main": "lib/exported",
   "exports": {
@@ -46,7 +46,7 @@
     "@salesforce/o11y-reporter": "1.8.1",
     "applicationinsights": "^2.9.8",
     "got": "^11",
-    "o11y_schema": "^260.46.0",
+    "o11y_schema": "^260.47.0",
     "proxy-agent": "^6.5.0"
   },
   "devDependencies": {