fix: Preserve OpenAI return values

e2e/helpers/openai-scenario.mjs

@@ -149,15 +149,15 @@ export async function runOpenAIScenario(options) {
             ],
             max_tokens: 16,
             temperature: 0,
+            stream_options: {
+              include_usage: true,
+            },
           };
 
           if (options.useSyncStreamHelper === false) {
             const stream = await client.chat.completions.create({
               ...streamArgs,
               stream: true,
-              stream_options: {
-                include_usage: true,
-              },
             });
             await collectAsync(stream);
           } else {

e2e/scenarios/openai-auto-instrumentation-node-hook/__snapshots__/openai-v4.span-events.json

@@ -291,13 +291,7 @@
       "scenario": null
     },
     "metric_keys": [
-      "completion_accepted_prediction_tokens",
-      "completion_audio_tokens",
-      "completion_reasoning_tokens",
-      "completion_rejected_prediction_tokens",
       "completion_tokens",
-      "prompt_audio_tokens",
-      "prompt_cached_tokens",
       "prompt_tokens",
       "time_to_first_token",
       "tokens"
@@ -646,7 +640,7 @@
       "time_to_first_token",
       "tokens"
     ],
-    "name": "openai.responses.create",
+    "name": "openai.responses.parse",
     "root_span_id": "<span:1>",
     "span_id": "<span:29>",
     "span_parents": [

e2e/scenarios/openai-auto-instrumentation-node-hook/__snapshots__/openai-v5.span-events.json

@@ -291,13 +291,7 @@
       "scenario": null
     },
     "metric_keys": [
-      "completion_accepted_prediction_tokens",
-      "completion_audio_tokens",
-      "completion_reasoning_tokens",
-      "completion_rejected_prediction_tokens",
       "completion_tokens",
-      "prompt_audio_tokens",
-      "prompt_cached_tokens",
       "prompt_tokens",
       "time_to_first_token",
       "tokens"
@@ -646,7 +640,7 @@
       "time_to_first_token",
       "tokens"
     ],
-    "name": "openai.responses.create",
+    "name": "openai.responses.parse",
     "root_span_id": "<span:1>",
     "span_id": "<span:29>",
     "span_parents": [

e2e/scenarios/openai-auto-instrumentation-node-hook/__snapshots__/openai.span-events.json

@@ -291,13 +291,7 @@
       "scenario": null
     },
     "metric_keys": [
-      "completion_accepted_prediction_tokens",
-      "completion_audio_tokens",
-      "completion_reasoning_tokens",
-      "completion_rejected_prediction_tokens",
       "completion_tokens",
-      "prompt_audio_tokens",
-      "prompt_cached_tokens",
       "prompt_tokens",
       "time_to_first_token",
       "tokens"
@@ -646,7 +640,7 @@
       "time_to_first_token",
       "tokens"
     ],
-    "name": "openai.responses.create",
+    "name": "openai.responses.parse",
     "root_span_id": "<span:1>",
     "span_id": "<span:29>",
     "span_parents": [

e2e/scenarios/openai-auto-instrumentation-node-hook/scenario.impl.mjs

@@ -18,9 +18,6 @@ export async function runOpenAIAutoInstrumentationNodeHook(
     projectNameBase: "e2e-openai-auto-instrumentation-hook",
     rootName: "openai-auto-hook-root",
     scenarioName: "openai-auto-instrumentation-node-hook",
-    useChatParseHelper: false,
-    useResponsesParseHelper: false,
-    useSyncStreamHelper: false,
   });
 }
 

js/src/auto-instrumentations/configs/openai.ts

@@ -24,7 +24,7 @@ export const openaiConfigs: InstrumentationConfig[] = [
     functionQuery: {
       className: "Completions",
       methodName: "create",
-      kind: "Async",
+      kind: "Sync",
     },
   },
 
@@ -38,7 +38,7 @@ export const openaiConfigs: InstrumentationConfig[] = [
     functionQuery: {
       className: "Completions",
       methodName: "create",
-      kind: "Async",
+      kind: "Sync",
     },
   },
 
@@ -52,7 +52,7 @@ export const openaiConfigs: InstrumentationConfig[] = [
     functionQuery: {
       className: "Completions",
       methodName: "create",
-      kind: "Async",
+      kind: "Sync",
     },
   },
 
@@ -67,7 +67,7 @@ export const openaiConfigs: InstrumentationConfig[] = [
     functionQuery: {
       className: "Embeddings",
       methodName: "create",
-      kind: "Async",
+      kind: "Sync",
     },
   },
 
@@ -82,7 +82,7 @@ export const openaiConfigs: InstrumentationConfig[] = [
     functionQuery: {
       className: "Completions",
       methodName: "parse",
-      kind: "Async",
+      kind: "Sync",
     },
   },
 
@@ -96,7 +96,7 @@ export const openaiConfigs: InstrumentationConfig[] = [
     functionQuery: {
       className: "Completions",
       methodName: "parse",
-      kind: "Async",
+      kind: "Sync",
     },
   },
 
@@ -111,7 +111,7 @@ export const openaiConfigs: InstrumentationConfig[] = [
     functionQuery: {
       className: "Moderations",
       methodName: "create",
-      kind: "Async",
+      kind: "Sync",
     },
   },
 
@@ -155,7 +155,7 @@ export const openaiConfigs: InstrumentationConfig[] = [
     functionQuery: {
       className: "Responses",
       methodName: "create",
-      kind: "Async",
+      kind: "Sync",
     },
   },
 
@@ -183,7 +183,7 @@ export const openaiConfigs: InstrumentationConfig[] = [
     functionQuery: {
       className: "Responses",
       methodName: "parse",
-      kind: "Async",
+      kind: "Sync",
     },
   },
 ];

js/src/instrumentation/core/channel-tracing.test.ts

@@ -1,3 +1,4 @@
+import { EventEmitter } from "node:events";
 import { afterEach, beforeAll, beforeEach, describe, expect, it } from "vitest";
 import {
   _exportsForTestingOnly,
@@ -8,13 +9,17 @@ import {
 } from "../../logger";
 import { configureNode } from "../../node/config";
 import { channel, defineChannels } from "./channel-definitions";
-import { traceAsyncChannel } from "./channel-tracing";
+import { traceAsyncChannel, traceSyncStreamChannel } from "./channel-tracing";
 
 const testChannels = defineChannels("channel-tracing-test", {
   asyncCall: channel<[Record<string, never>], { ok: true }>({
     channelName: "async.call",
     kind: "async",
   }),
+  syncStreamCall: channel<[Record<string, never>], EventEmitter>({
+    channelName: "sync-stream.call",
+    kind: "sync-stream",
+  }),
 });
 
 describe("traceAsyncChannel current span binding", () => {
@@ -74,4 +79,63 @@ describe("traceAsyncChannel current span binding", () => {
     const spans = await backgroundLogger.drain();
     expect(spans).toHaveLength(1);
   });
+
+  it("logs totalUsage metrics for sync streams", async () => {
+    const unsubscribe = traceSyncStreamChannel(testChannels.syncStreamCall, {
+      name: "channel-tracing-sync-stream",
+      type: "llm",
+      extractInput: () => ({
+        input: "input",
+        metadata: { provider: "openai" },
+      }),
+      extractFromTotalUsage: () => ({
+        metrics: {
+          prompt_tokens: 3,
+          completion_tokens: 2,
+          tokens: 5,
+        },
+      }),
+    });
+
+    try {
+      const stream = new EventEmitter();
+      const result = testChannels.syncStreamCall.traceSync(() => stream, {
+        arguments: [{}],
+      } as any);
+
+      expect(result).toBe(stream);
+
+      stream.emit("chunk", { delta: { content: "hello" } });
+      stream.emit("chatCompletion", {
+        choices: [{ message: { role: "assistant", content: "hello world" } }],
+      });
+      stream.emit("totalUsage", {
+        prompt_tokens: 3,
+        completion_tokens: 2,
+        total_tokens: 5,
+      });
+      stream.emit("end");
+
+      await new Promise((resolve) => setImmediate(resolve));
+    } finally {
+      unsubscribe();
+    }
+
+    const spans = await backgroundLogger.drain();
+    expect(spans).toHaveLength(1);
+    expect(spans[0]).toMatchObject({
+      metadata: {
+        provider: "openai",
+      },
+      output: [{ message: { role: "assistant", content: "hello world" } }],
+      metrics: expect.objectContaining({
+        prompt_tokens: 3,
+        completion_tokens: 2,
+        tokens: 5,
+      }),
+    });
+    expect(
+      (spans[0] as Record<string, any>).metrics.time_to_first_token,
+    ).toEqual(expect.any(Number));
+  });
 });