@overmind-lab/trace-sdk 0.0.1

package/src/instrumentation-openai/types.ts

@@ -0,0 +1,34 @@
+import type { InstrumentationConfig } from "@opentelemetry/instrumentation";
+
+export type ImageUploadCallback = (
+  traceId: string,
+  spanId: string,
+  filename: string,
+  base64Data: string
+) => Promise<string>;
+
+export interface OpenAIInstrumentationConfig extends InstrumentationConfig {
+  /**
+   * Whether to log prompts, completions and embeddings on traces.
+   * @default true
+   */
+  traceContent?: boolean;
+
+  /**
+   * Whether to enrich token information if missing from the trace.
+   * @default false
+   */
+  enrichTokens?: boolean;
+
+  /**
+   * A custom logger to log any exceptions that happen during span creation.
+   */
+  exceptionLogger?: (e: Error) => void;
+
+  /**
+   * Callback function for uploading base64-encoded images.
+   * Used for image generation and vision capabilities.
+   * @default undefined
+   */
+  uploadBase64Image?: ImageUploadCallback;
+}

package/src/overmind-client.ts

@@ -0,0 +1,95 @@
+import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-proto";
+import type { Instrumentation } from "@opentelemetry/instrumentation";
+import { resourceFromAttributes } from "@opentelemetry/resources";
+import { NodeSDK } from "@opentelemetry/sdk-node";
+import {
+  BatchSpanProcessor,
+  SimpleSpanProcessor,
+  type SpanProcessor,
+} from "@opentelemetry/sdk-trace-base";
+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 { name, version } from "../package.json";
+
+type OvermindClientConfig = {
+  apiKey: string;
+  baseUrl?: string;
+  appName?: string;
+};
+
+export class OvermindClient {
+  public readonly appName: string;
+  private version: string = version;
+  private baseUrl: string;
+  private apiKey: string;
+  public experimentSlug?: string;
+
+  constructor(config: OvermindClientConfig) {
+    this.baseUrl =
+      config.baseUrl || process.env.OVERMIND_TRACES_URL || "https://api.overmindlab.ai";
+
+    this.apiKey = config.apiKey || process.env.OVERMIND_API_KEY!;
+
+    this.appName = config.appName || "overmind-js";
+    if (!this.apiKey) {
+      throw new Error("OVERMIND_API_KEY is not set");
+    }
+    if (!this.baseUrl) {
+      throw new Error("OVERMIND_TRACES_URL is not set");
+    }
+  }
+
+  initTracing({
+    instrumentations = [],
+    spanProcessors = [],
+    ...config
+  }: {
+    instrumentations?: Instrumentation[];
+    spanProcessors?: SpanProcessor[];
+    enableBatching: boolean;
+    enabledProviders: Partial<Record<"openai" | "anthropic", boolean>>;
+  }) {
+    const traceExporter = !this.baseUrl
+      ? new OTLPTraceExporter({
+          url: `${this.baseUrl}/api/v1/traces/create`,
+          headers: {
+            "X-API-TOKEN": `Bearer ${this.apiKey}`,
+          },
+        })
+      : new ConsoleSpanExporter();
+
+    const spanProcessor = config.enableBatching
+      ? new BatchSpanProcessor(traceExporter)
+      : new SimpleSpanProcessor(traceExporter);
+
+    spanProcessors.push(spanProcessor);
+
+    const resource = resourceFromAttributes({
+      [ATTR_SERVICE_NAME]: this.appName,
+      [ATTR_SERVICE_VERSION]: this.version,
+      "deployment.environment": process.env.DEPLOYMENT_ENVIRONMENT || "development",
+      "overmind.sdk.name": name,
+      "overmind.sdk.version": this.version,
+    });
+
+    if (config.enabledProviders.openai) {
+      const openaiInstrumentation = new OpenAIInstrumentation({
+        enabled: true,
+      });
+      openaiInstrumentation.manuallyInstrument(OpenAI);
+      instrumentations.push(openaiInstrumentation);
+    }
+
+    const _sdk = new NodeSDK({
+      resource,
+      spanProcessors,
+      instrumentations: [...instrumentations],
+    });
+
+    _sdk.start();
+  }
+}