@zoklens/sdk

LLM & Agent Observability for JavaScript/TypeScript via OpenTelemetry.

Quick Start

npm install @zoklens/sdk

import { ZokLens } from '@zoklens/sdk';

const zl = new ZokLens({
  apiKey: 'zok_xxx',
  endpoint: 'https://api.zoklens.com',
  project: 'my-agent',
});

// Auto-instrument OpenAI
zl.instrument({ providers: ['openai'] });

// Your existing code — traces captured automatically
import OpenAI from 'openai';
const client = new OpenAI();
const response = await client.chat.completions.create({
  model: 'gpt-4o',
  messages: [{ role: 'user', content: 'Hello!' }],
});

Manual Spans

const span = zl.startSpan('retrieval', { query: 'cost trends' });
const docs = await retriever.search(query);
span.end();

Session Tracking

const session = zl.startSession({ userId: 'u123' });
// All spans auto-associate with this session
const span = zl.startSpan('step-1');
span.end();
session.end();

Shutdown

await zl.shutdown();

Requirements

• Node.js ≥ 18
• TypeScript ≥ 5.3 (optional)

License

Apache-2.0