fix(otel): Transform v1 spans into v2 compatible format before exporting

.changeset/calm-scope-sparkle.md

@@ -0,0 +1,5 @@
+---
+"@braintrust/otel": patch
+---
+
+fix(otel): Transform v1 spans into v2 compatible format before exporting

e2e/scenarios/otel-v1-span-processor-export/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@braintrust/e2e-otel-v1-span-processor-export",
+  "private": true,
+  "dependencies": {
+    "@opentelemetry/api": "1.9.0",
+    "@opentelemetry/sdk-trace-base": "1.30.1"
+  }
+}

e2e/scenarios/otel-v1-span-processor-export/scenario.test.ts

@@ -0,0 +1,86 @@
+import { readFile } from "node:fs/promises";
+import { createRequire } from "node:module";
+import { expect, test } from "vitest";
+import {
+  prepareScenarioDir,
+  readInstalledPackageVersion,
+  resolveScenarioDir,
+  withScenarioHarness,
+} from "../../helpers/scenario-harness";
+import { extractOtelSpans } from "../../helpers/trace-summary";
+
+const scenarioDir = await prepareScenarioDir({
+  scenarioDir: resolveScenarioDir(import.meta.url),
+});
+const require = createRequire(import.meta.url);
+const otelSdkVersion = await readInstalledPackageVersion(
+  scenarioDir,
+  "@opentelemetry/sdk-trace-base",
+);
+const braintrustOtelEntry = require.resolve("@braintrust/otel");
+const otlpExporterManifestPath = require.resolve(
+  "@opentelemetry/exporter-trace-otlp-http/package.json",
+  {
+    paths: [braintrustOtelEntry],
+  },
+);
+const otlpExporterManifest = JSON.parse(
+  await readFile(otlpExporterManifestPath, "utf8"),
+) as { version: string };
+const otlpExporterVersion = otlpExporterManifest.version;
+
+type OtlpTraceRequest = {
+  resourceSpans?: Array<{
+    scopeSpans?: Array<{
+      scope?: {
+        name?: string;
+        version?: string;
+      };
+      spans?: Array<{
+        name?: string;
+      }>;
+    }>;
+  }>;
+};
+
+test(`otel-v1-span-processor-export exports real OTel ${otelSdkVersion} spans through OTLP exporter ${otlpExporterVersion}`, async () => {
+  expect(otelSdkVersion).toMatch(/^1\./);
+  expect(Number(otlpExporterVersion.split(".")[1])).toBeGreaterThanOrEqual(200);
+
+  await withScenarioHarness(
+    async ({ requestsAfter, runScenarioDir, testRunId }) => {
+      await runScenarioDir({ scenarioDir });
+
+      const requests = requestsAfter(
+        0,
+        (request) => request.path === "/otel/v1/traces",
+      );
+      expect(requests).toHaveLength(1);
+
+      const request = requests[0];
+      const spans = extractOtelSpans(request.jsonBody);
+      const rootSpan = spans.find((span) => span.name === "otel-v1-root");
+      const compatSpan = spans.find(
+        (span) => span.name === "gen_ai.otel-v1-compat",
+      );
+      const body = request.jsonBody as OtlpTraceRequest;
+      const scopeSpan = body.resourceSpans
+        ?.flatMap((resourceSpan) => resourceSpan.scopeSpans ?? [])
+        .find((candidate) =>
+          candidate.spans?.some(
+            (span) => span.name === "gen_ai.otel-v1-compat",
+          ),
+        );
+
+      expect(request.headers["x-bt-parent"]).toContain(testRunId.toLowerCase());
+      expect(scopeSpan?.scope).toEqual({
+        name: "otel-v1-e2e-lib",
+        version: "1.2.3",
+      });
+      expect(rootSpan?.spanId).toBeDefined();
+      expect(compatSpan?.parentSpanId).toBe(rootSpan?.spanId);
+      expect(compatSpan?.attributes["gen_ai.system"]).toBe("openai");
+      expect(compatSpan?.attributes.testRunId).toBe(testRunId);
+    },
+  );
+});

e2e/scenarios/otel-v1-span-processor-export/scenario.ts

@@ -0,0 +1,41 @@
+import { context, trace } from "@opentelemetry/api";
+import { BasicTracerProvider } from "@opentelemetry/sdk-trace-base";
+import { BraintrustSpanProcessor } from "@braintrust/otel";
+import {
+  getTestRunId,
+  runMain,
+  scopedName,
+} from "../../helpers/scenario-runtime";
+
+async function main() {
+  const testRunId = getTestRunId();
+  const processor = new BraintrustSpanProcessor({
+    apiKey: process.env.BRAINTRUST_API_KEY!,
+    apiUrl: process.env.BRAINTRUST_API_URL!,
+    parent: `project_name:${scopedName("e2e-otel-v1-span-processor-export", testRunId)}`,
+  });
+  const provider = new BasicTracerProvider() as BasicTracerProvider & {
+    addSpanProcessor: (processor: BraintrustSpanProcessor) => void;
+  };
+  provider.addSpanProcessor(processor);
+  trace.setGlobalTracerProvider(provider);
+
+  const tracer = trace.getTracer("otel-v1-e2e-lib", "1.2.3");
+  const rootSpan = tracer.startSpan("otel-v1-root");
+  const rootContext = trace.setSpan(context.active(), rootSpan);
+  const aiSpan = tracer.startSpan(
+    "gen_ai.otel-v1-compat",
+    undefined,
+    rootContext,
+  );
+  aiSpan.setAttribute("gen_ai.system", "openai");
+  aiSpan.setAttribute("scenario", "otel-v1-span-processor-export");
+  aiSpan.setAttribute("testRunId", testRunId);
+  aiSpan.end();
+  rootSpan.end();
+
+  await processor.forceFlush();
+  await provider.shutdown();
+}
+
+runMain(main);

integrations/otel-js/otel-v1/package.json

@@ -19,7 +19,7 @@
     "build": "tsup",
     "watch": "tsup --watch",
     "clean": "rm -rf dist/*",
-    "build:deps": "(cd ../../../.. && pnpm turbo run build --filter=braintrust --filter=@braintrust/otel)",
+    "build:deps": "(cd ../../.. && pnpm turbo run build --filter=braintrust --filter=@braintrust/otel)",
     "test": "pnpm run build:deps && vitest run"
   },
   "author": "Braintrust Data Inc.",

integrations/otel-js/otel-v2/package.json

@@ -19,7 +19,7 @@
     "build": "tsup",
     "watch": "tsup --watch",
     "clean": "rm -rf dist/*",
-    "build:deps": "(cd ../../../.. && pnpm turbo run build --filter=braintrust --filter=@braintrust/otel)",
+    "build:deps": "(cd ../../.. && pnpm turbo run build --filter=braintrust --filter=@braintrust/otel)",
     "test": "pnpm run build:deps && vitest run"
   },
   "author": "Braintrust Data Inc.",

integrations/otel-js/package.json

@@ -27,6 +27,7 @@
   "author": "Braintrust Data Inc.",
   "license": "MIT",
   "devDependencies": {
+    "@opentelemetry/context-async-hooks": "2.6.1",
     "@types/node": "^22.15.21",
     "braintrust": "workspace:*",
     "tsup": "^8.5.0",