@overmind-lab/trace-sdk 0.0.1 → 0.0.3

package/README.md

@@ -1,4 +1,4 @@
-# overmind-js
+# @overmind-lab/trace-sdk
 
 JavaScript/TypeScript SDK for [Overmind](https://overmindlab.ai) — automatic LLM observability powered by OpenTelemetry.
 
@@ -9,9 +9,9 @@ Instrument your OpenAI calls with a single `initTracing()` call. Traces are expo
 ## Installation
 
 ```bash
-bun add overmind-js openai
+bun add @overmind-lab/trace-sdk openai
 # or
-npm install overmind-js openai
+npm install @overmind-lab/trace-sdk openai
 ```
 
 ---
@@ -20,7 +20,7 @@ npm install overmind-js openai
 
 ```ts
 import { OpenAI } from "openai";
-import { OvermindClient } from "overmind-js";
+import { OvermindClient } from "@overmind-lab/trace-sdk";
 
 // 1. Create the client
 const overmindClient = new OvermindClient({
@@ -31,7 +31,7 @@ const overmindClient = new OvermindClient({
 // 2. Initialize tracing — must be called before any OpenAI calls
 overmindClient.initTracing({
   enableBatching: false,
-  enabledProviders: { openai: true },
+  enabledProviders: { openai: OpenAI }, // this is important to patch the correct client
   instrumentations: [],
 });
 
@@ -64,7 +64,7 @@ Traces are sent automatically to `https://api.overmindlab.ai` and will appear in
 
 | Option | Type | Required | Description |
 |---|---|---|---|
-| `enabledProviders` | `{ openai?: boolean; anthropic?: boolean }` | Yes | Which LLM providers to instrument. |
+| `enabledProviders` | `{ openai?: typeof OpenAI }` | Yes | Pass the imported provider class to monkey-patch. e.g. `{ openai: OpenAI }` where `OpenAI` is imported from `"openai"`. |
 | `enableBatching` | `boolean` | Yes | `true` to batch spans before export (recommended for production), `false` to export immediately. |
 | `instrumentations` | `Instrumentation[]` | No | Additional OpenTelemetry instrumentations to register. |
 | `spanProcessors` | `SpanProcessor[]` | No | Additional span processors (e.g. custom exporters). |
@@ -84,7 +84,7 @@ Traces are sent automatically to `https://api.overmindlab.ai` and will appear in
 
 ## What Gets Traced
 
-When `enabledProviders: { openai: true }` is set, the SDK automatically captures:
+When `enabledProviders: { openai: OpenAI }` is set, the SDK automatically captures:
 
 - Prompts and completions
 - Model name, temperature, top-p, max tokens
@@ -103,7 +103,7 @@ Enable batching in production to reduce network overhead:
 ```ts
 overmindClient.initTracing({
   enableBatching: true, // buffer spans and flush in batches
-  enabledProviders: { openai: true },
+  enabledProviders: { openai: OpenAI },
 });
 ```
 

package/package.json

@@ -4,19 +4,20 @@
     "@opentelemetry/exporter-trace-otlp-proto": "^0.212.0",
     "@opentelemetry/instrumentation-openai": "^0.10.0",
     "@opentelemetry/sdk-node": "^0.212.0",
-    "@opentelemetry/sdk-trace-node": "^2.5.1",
-    "@traceloop/instrumentation-openai": "^0.22.5",
-    "openai": "^6.22.0"
+    "@opentelemetry/sdk-trace-node": "^2.5.1"
   },
   "devDependencies": {
     "@biomejs/biome": "^2.4.3"
   },
+  "peerDependencies": {
+    "openai": "*"
+  },
   "name": "@overmind-lab/trace-sdk",
   "packageManager": "bun@1.3.5",
   "private": false,
   "publishConfig": {
     "access": "public",
-    "tag": "alpha"
+    "tag": "latest"
   },
   "scripts": {
     "build": "tsc",
@@ -24,5 +25,5 @@
     "dev": "tsx watch src/index.ts",
     "format": "biome format --write"
   },
-  "version": "0.0.1"
+  "version": "0.0.3"
 }

package/src/overmind-client.ts

@@ -10,10 +10,10 @@ import {
 import { ConsoleSpanExporter } from "@opentelemetry/sdk-trace-node";
 import { ATTR_SERVICE_NAME, ATTR_SERVICE_VERSION } from "@opentelemetry/semantic-conventions";
 
-import OpenAI from "openai";
-import { OpenAIInstrumentation } from "./instrumentation-openai";
+import type { OpenAI } from "openai";
 
 import { name, version } from "../package.json";
+import { OpenAIInstrumentation } from "./instrumentation-openai";
 
 type OvermindClientConfig = {
   apiKey: string;
@@ -26,6 +26,7 @@ export class OvermindClient {
   private version: string = version;
   private baseUrl: string;
   private apiKey: string;
+  private sdk?: NodeSDK;
   public experimentSlug?: string;
 
   constructor(config: OvermindClientConfig) {
@@ -51,14 +52,14 @@ export class OvermindClient {
     instrumentations?: Instrumentation[];
     spanProcessors?: SpanProcessor[];
     enableBatching: boolean;
-    enabledProviders: Partial<Record<"openai" | "anthropic", boolean>>;
+    enabledProviders: { openai: OpenAI };
   }) {
-    const traceExporter = !this.baseUrl
+    const traceExporter = this.baseUrl
       ? new OTLPTraceExporter({
-          url: `${this.baseUrl}/api/v1/traces/create`,
           headers: {
-            "X-API-TOKEN": `Bearer ${this.apiKey}`,
+            "X-API-TOKEN": this.apiKey,
           },
+          url: `${this.baseUrl}/api/v1/traces/create`,
         })
       : new ConsoleSpanExporter();
 
@@ -80,16 +81,20 @@ export class OvermindClient {
       const openaiInstrumentation = new OpenAIInstrumentation({
         enabled: true,
       });
-      openaiInstrumentation.manuallyInstrument(OpenAI);
+      openaiInstrumentation.manuallyInstrument(config.enabledProviders.openai);
       instrumentations.push(openaiInstrumentation);
     }
 
-    const _sdk = new NodeSDK({
+    this.sdk = new NodeSDK({
+      instrumentations: [...instrumentations],
       resource,
       spanProcessors,
-      instrumentations: [...instrumentations],
     });
 
-    _sdk.start();
+    this.sdk.start();
+  }
+
+  async shutdown() {
+    await this.sdk?.shutdown();
   }
 }