@latitude-data/telemetry 2.0.4 → 3.0.0-alpha.1

package/LICENSE

@@ -0,0 +1,157 @@
+# GNU LESSER GENERAL PUBLIC LICENSE
+
+Version 3, 29 June 2007
+
+Copyright (C) 2007 Free Software Foundation, Inc.
+<https://fsf.org/>
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+This version of the GNU Lesser General Public License incorporates the
+terms and conditions of version 3 of the GNU General Public License,
+supplemented by the additional permissions listed below.
+
+## 0. Additional Definitions.
+
+As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the
+GNU General Public License.
+
+"The Library" refers to a covered work governed by this License, other
+than an Application or a Combined Work as defined below.
+
+An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+A "Combined Work" is a work produced by combining or linking an
+Application with the Library. The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+## 1. Exception to Section 3 of the GNU GPL.
+
+You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+## 2. Conveying Modified Versions.
+
+If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+-   a) under this License, provided that you make a good faith effort
+    to ensure that, in the event an Application does not supply the
+    function or data, the facility still operates, and performs
+    whatever part of its purpose remains meaningful, or
+-   b) under the GNU GPL, with none of the additional permissions of
+    this License applicable to that copy.
+
+## 3. Object Code Incorporating Material from Library Header Files.
+
+The object code form of an Application may incorporate material from a
+header file that is part of the Library. You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+-   a) Give prominent notice with each copy of the object code that
+    the Library is used in it and that the Library and its use are
+    covered by this License.
+-   b) Accompany the object code with a copy of the GNU GPL and this
+    license document.
+
+## 4. Combined Works.
+
+You may convey a Combined Work under terms of your choice that, taken
+together, effectively do not restrict modification of the portions of
+the Library contained in the Combined Work and reverse engineering for
+debugging such modifications, if you also do each of the following:
+
+-   a) Give prominent notice with each copy of the Combined Work that
+    the Library is used in it and that the Library and its use are
+    covered by this License.
+-   b) Accompany the Combined Work with a copy of the GNU GPL and this
+    license document.
+-   c) For a Combined Work that displays copyright notices during
+    execution, include the copyright notice for the Library among
+    these notices, as well as a reference directing the user to the
+    copies of the GNU GPL and this license document.
+-   d) Do one of the following:
+    -   0) Convey the Minimal Corresponding Source under the terms of
+        this License, and the Corresponding Application Code in a form
+        suitable for, and under terms that permit, the user to
+        recombine or relink the Application with a modified version of
+        the Linked Version to produce a modified Combined Work, in the
+        manner specified by section 6 of the GNU GPL for conveying
+        Corresponding Source.
+    -   1) Use a suitable shared library mechanism for linking with
+        the Library. A suitable mechanism is one that (a) uses at run
+        time a copy of the Library already present on the user's
+        computer system, and (b) will operate properly with a modified
+        version of the Library that is interface-compatible with the
+        Linked Version.
+-   e) Provide Installation Information, but only if you would
+    otherwise be required to provide such information under section 6
+    of the GNU GPL, and only to the extent that such information is
+    necessary to install and execute a modified version of the
+    Combined Work produced by recombining or relinking the Application
+    with a modified version of the Linked Version. (If you use option
+    4d0, the Installation Information must accompany the Minimal
+    Corresponding Source and Corresponding Application Code. If you
+    use option 4d1, you must provide the Installation Information in
+    the manner specified by section 6 of the GNU GPL for conveying
+    Corresponding Source.)
+
+## 5. Combined Libraries.
+
+You may place library facilities that are a work based on the Library
+side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+-   a) Accompany the combined library with a copy of the same work
+    based on the Library, uncombined with any other library
+    facilities, conveyed under the terms of this License.
+-   b) Give prominent notice with the combined library that part of it
+    is a work based on the Library, and explaining where to find the
+    accompanying uncombined form of the same work.
+
+## 6. Revised Versions of the GNU Lesser General Public License.
+
+The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+Each version is given a distinguishing version number. If the Library
+as you received it specifies that a certain numbered version of the
+GNU Lesser General Public License "or any later version" applies to
+it, you have the option of following the terms and conditions either
+of that published version or of any later version published by the
+Free Software Foundation. If the Library as you received it does not
+specify a version number of the GNU Lesser General Public License, you
+may choose any version of the GNU Lesser General Public License ever
+published by the Free Software Foundation.
+
+If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

package/README.md

@@ -1,52 +1,476 @@
-# Latitude Telemetry for Typescript & Javascript
+# Latitude Telemetry for TypeScript
+
+Instrument your AI application and send traces to [Latitude](https://latitude.so). Built on [OpenTelemetry](https://opentelemetry.io/).
+
+## Installation
 
 ```sh
 npm install @latitude-data/telemetry
 ```
 
-Requires Node.js `20` or higher.
+## Quick Start
+
+### Bootstrap (Recommended)
+
+The fastest way to start tracing your LLM calls. One function sets up everything:
+
+```typescript
+import { initLatitude } from "@latitude-data/telemetry";
+
+const latitude = initLatitude({
+  apiKey: process.env.LATITUDE_API_KEY!,
+  projectSlug: process.env.LATITUDE_PROJECT_SLUG!,
+  instrumentations: ["openai"], // Auto-instrument OpenAI, Anthropic, etc.
+});
+
+// Optionally wait for instrumentations to be ready
+await latitude.ready;
+
+// Your LLM calls will now be traced and sent to Latitude
+const response = await openai.chat.completions.create({
+  model: "gpt-4",
+  messages: [{ role: "user", content: "Hello" }],
+});
+
+await latitude.shutdown();
+```
+
+**What this does:**
+
+- Creates a complete OpenTelemetry setup
+- Registers LLM auto-instrumentation (OpenAI, Anthropic, etc.) **asynchronously in the background**
+- Configures the Latitude span processor and exporter
+- Sets up async context propagation (for passing context through async operations)
+
+**Key point about async instrumentations:**
+
+`initLatitude` returns **immediately** — no top-level await needed. Instrumentation registration happens in the background. This avoids top-level await issues in CommonJS environments while still supporting ESM.
+
+- **Fire-and-forget**: Start using your LLM clients right away. Early spans will be captured once instrumentations finish registering.
+- **Optional `await latitude.ready`**: If you want to ensure instrumentations are fully registered before making LLM calls, await the `ready` promise.
+
+**When to use this:** Most applications should start here. It's the simplest path to get LLM observability into Latitude.
+
+**When you might need the advanced setup:**
+
+- You already have OpenTelemetry configured for other backends (Datadog, Sentry, Jaeger)
+- You need custom span processing, sampling, or filtering
+- You want multiple observability backends receiving the same spans
+
+### Existing OpenTelemetry Setup (Advanced)
+
+If your app already uses OpenTelemetry, add Latitude alongside your existing setup:
+
+```typescript
+import { NodeSDK } from "@opentelemetry/sdk-node";
+import {
+  LatitudeSpanProcessor,
+  registerLatitudeInstrumentations,
+} from "@latitude-data/telemetry";
+
+const sdk = new NodeSDK({
+  spanProcessors: [
+    existingProcessor, // Your existing processor
+    new LatitudeSpanProcessor(
+      process.env.LATITUDE_API_KEY!,
+      process.env.LATITUDE_PROJECT_SLUG!,
+    ),
+  ],
+});
+
+sdk.start();
+
+// Enable LLM auto-instrumentation
+await registerLatitudeInstrumentations({
+  instrumentations: ["openai"],
+  tracerProvider: sdk.getTracerProvider(),
+});
+
+// Your LLM calls will now be traced and sent to Latitude
+const response = await openai.chat.completions.create({
+  model: "gpt-4",
+  messages: [{ role: "user", content: "Hello" }],
+});
+```
+
+### Why OpenTelemetry?
+
+Latitude Telemetry is built entirely on OpenTelemetry standards. When you're ready to add other observability tools (Datadog, Sentry, Jaeger, etc.), you can use them alongside Latitude without conflicts:
+
+- **Standard span processors** — `LatitudeSpanProcessor` works with any `NodeSDK` or `NodeTracerProvider`
+- **Smart filtering** — Only LLM-relevant spans are exported to Latitude (spans with `gen_ai.*`, `llm.*`, `openinference.*`, or `ai.*` attributes, plus known LLM instrumentation scopes)
+- **Compatible with existing instrumentations** — Works alongside HTTP, DB, and other OTel instrumentations
+- **No vendor lock-in** — Standard OTLP export, no proprietary wire format
+
+## Using `capture()` for Context and Boundaries
+
+The SDK automatically traces LLM calls when you use auto-instrumentation. However, you may want to add additional context (user ID, session ID, tags, or metadata) to group related spans together.
+
+### What `capture()` Does
+
+`capture()` wraps your code to attach Latitude context to all LLM spans created inside the callback:
+
+- Adds attributes like `user.id`, `session.id`, `latitude.tags`, and `latitude.metadata` to every span
+- Creates a named boundary for grouping related traces
+- Uses OpenTelemetry's native `context.with()` for reliable async propagation
+
+### When to Use It
+
+You don't need `capture()` to get started—auto-instrumentation handles LLM calls automatically. Use `capture()` when you want to:
+
+- **Group traces by user or session** — Track all LLM calls from a specific user or session
+- **Add business context** — Tag traces with deployment environment, feature flags, or request IDs
+- **Mark agent boundaries** — Wrap an entire agent run or conversation turn with a name and metadata
+- **Filter and analyze** — Use tags and metadata to filter traces in the Latitude
+
+### Example
+
+```typescript
+import { initLatitude, capture } from "@latitude-data/telemetry";
+
+const latitude = initLatitude({
+  apiKey: process.env.LATITUDE_API_KEY!,
+  projectSlug: process.env.LATITUDE_PROJECT_SLUG!,
+  instrumentations: ["openai"],
+});
+
+// Optional: wait for instrumentations before starting
+await latitude.ready;
+
+// Wrap a request or agent run to add context
+await capture(
+  "handle-user-request",
+  async () => {
+    const result = await agent.process(userMessage);
+    return result;
+  },
+  {
+    userId: "user_123",
+    sessionId: "session_abc",
+    tags: ["production", "v2-agent"],
+    metadata: { requestId: "req-xyz", featureFlag: "new-prompt" },
+  },
+);
+
+await latitude.shutdown();
+```
+
+**Important:** `capture()` does not create spans—it only attaches context to spans created by auto-instrumentation. Use one `capture()` call at the request or agent boundary. You can nest calls for granular context; child spans inherit from parent context with local overrides.
+
+## Key Concepts
+
+- **`initLatitude()`** — The primary way to use Latitude. Bootstraps a complete OpenTelemetry setup with LLM auto-instrumentation and the Latitude exporter. Best for most applications.
+- **`LatitudeSpanProcessor`** — For advanced use cases where you already have an OpenTelemetry setup. Exports spans to Latitude alongside your existing observability stack.
+- **`registerLatitudeInstrumentations()`** — Registers LLM auto-instrumentations (OpenAI, Anthropic, etc.) when using the advanced setup with your own provider.
+- **`capture()`** — Optional. Wraps your code to attach Latitude context (tags, userId, sessionId, metadata) to all spans created inside the callback. Use this when you want to group traces by user, session, or add business context.
+
+**Important:** Auto-instrumentation traces LLM calls without `capture()`. Use `capture()` only when you need to add context or mark boundaries. Wrap the request, job, or agent entrypoint once—you don't need to wrap every internal step.
+
+## Public API
+
+```typescript
+import {
+  initLatitude,
+  LatitudeSpanProcessor,
+  capture,
+  registerLatitudeInstrumentations,
+} from "@latitude-data/telemetry";
+```
+
+### `initLatitude(options)`
+
+The primary entry point. Bootstraps a complete OpenTelemetry setup with LLM instrumentations and Latitude export.
+
+```typescript
+type InitLatitudeOptions = {
+  apiKey: string;
+  projectSlug: string;
+  instrumentations?: InstrumentationType[]; // ["openai", "anthropic", etc.]
+  serviceName?: string;
+  disableBatch?: boolean;
+  disableSmartFilter?: boolean;
+  shouldExportSpan?: (span: ReadableSpan) => boolean;
+  blockedInstrumentationScopes?: string[];
+  disableRedact?: boolean;
+  redact?: RedactSpanProcessorOptions;
+  exporter?: SpanExporter;
+};
+
+function initLatitude(options: InitLatitudeOptions): {
+  provider: NodeTracerProvider; // Access to underlying provider for advanced use
+  ready: Promise<void>; // Resolves when instrumentations are registered
+  flush(): Promise<void>;
+  shutdown(): Promise<void>;
+};
+```
+
+### `LatitudeSpanProcessor`
+
+Span processor for shared-provider setups. Reads Latitude context from OTel context and stamps attributes onto spans.
+
+```typescript
+class LatitudeSpanProcessor implements SpanProcessor {
+  constructor(
+    apiKey: string,
+    projectSlug: string,
+    options?: LatitudeSpanProcessorOptions,
+  );
+}
+
+type LatitudeSpanProcessorOptions = {
+  disableBatch?: boolean;
+  disableSmartFilter?: boolean;
+  shouldExportSpan?: (span: ReadableSpan) => boolean;
+  blockedInstrumentationScopes?: string[];
+  disableRedact?: boolean;
+  redact?: RedactSpanProcessorOptions;
+  exporter?: SpanExporter;
+};
+```
+
+### `capture(name, fn, options?)`
+
+Wraps a function to attach Latitude context to all spans created inside. Uses OpenTelemetry's native `context.with()` for scoping.
+
+```typescript
+type ContextOptions = {
+  name?: string;
+  userId?: string;
+  sessionId?: string;
+  tags?: string[];
+  metadata?: Record<string, unknown>;
+};
+
+function capture<T>(
+  name: string,
+  fn: () => T | Promise<T>,
+  options?: ContextOptions,
+): T | Promise<T>;
+```
+
+**Nested `capture()` behavior:**
+
+- `userId`: last-write-wins
+- `sessionId`: last-write-wins
+- `metadata`: shallow merge
+- `tags`: append and dedupe while preserving order
+
+### `registerLatitudeInstrumentations(options)`
+
+Registers patch-based AI SDK instrumentations against a specific tracer provider.
+
+```typescript
+type InstrumentationType =
+  | "openai"
+  | "anthropic"
+  | "bedrock"
+  | "cohere"
+  | "langchain"
+  | "llamaindex"
+  | "togetherai"
+  | "vertexai"
+  | "aiplatform";
+
+function registerLatitudeInstrumentations(options: {
+  instrumentations: InstrumentationType[];
+  tracerProvider: TracerProvider;
+  instrumentationModules?: Partial<Record<InstrumentationType, unknown>>;
+}): Promise<void>;
+```
+
+## Vendor-Specific Integration Guides
 
-Go to the [documentation](https://docs.latitude.so/guides/sdk/typescript) to learn more.
+For users with existing observability infrastructure.
 
-## Usage
+### With Datadog
+
+Use Datadog's OTel `TracerProvider` with `LatitudeSpanProcessor`:
 
 ```typescript
-import { LatitudeTelemetry } from '@latitude-data/telemetry'
-import { Latitude } from '@latitude-data/sdk'
-import { OpenAI } from 'openai'
+import tracer from "dd-trace";
+import { LatitudeSpanProcessor } from "@latitude-data/telemetry";
+
+const ddTracer = tracer.init({ service: "my-app", env: "production" });
+const provider = new ddTracer.TracerProvider();
+
+provider.addSpanProcessor(
+  new LatitudeSpanProcessor(
+    process.env.LATITUDE_API_KEY!,
+    process.env.LATITUDE_PROJECT_SLUG!,
+  ),
+);
+
+provider.register();
+
+// LLM calls are now traced and sent to both Datadog and Latitude
+```
+
+**Adding context:** Use `capture()` if you want to add user IDs, session IDs, or tags to your traces (see [Using `capture()` for Context and Boundaries](#using-capture-for-context-and-boundaries)).
+
+### With Sentry
+
+Use Sentry's custom OpenTelemetry setup with `skipOpenTelemetrySetup: true`:
 
-const telemetry = new LatitudeTelemetry('my-api-key', {
-  instrumentations: {
-    latitude: Latitude,
-    openai: OpenAI,
+```typescript
+import * as Sentry from "@sentry/node";
+import {
+  SentrySpanProcessor,
+  SentrySampler,
+  SentryPropagator,
+} from "@sentry/opentelemetry";
+import { NodeTracerProvider } from "@opentelemetry/sdk-trace-node";
+import {
+  LatitudeSpanProcessor,
+  registerLatitudeInstrumentations,
+} from "@latitude-data/telemetry";
+
+// Initialize Sentry with custom OTel setup flag
+const sentryClient = Sentry.init({
+  dsn: process.env.SENTRY_DSN,
+  skipOpenTelemetrySetup: true,
+  tracesSampleRate: 1.0,
+});
+
+// Create a shared provider with both Sentry and Latitude processors
+const provider = new NodeTracerProvider({
+  sampler: sentryClient ? new SentrySampler(sentryClient) : undefined,
+  spanProcessors: [
+    new SentrySpanProcessor(), // Send spans to Sentry
+    new LatitudeSpanProcessor(
+      process.env.LATITUDE_API_KEY!,
+      process.env.LATITUDE_PROJECT_SLUG!,
+    ), // Send spans to Latitude
+  ],
+});
+
+// Register with Sentry's propagator and context manager
+provider.register({
+  propagator: new SentryPropagator(),
+  contextManager: new Sentry.SentryContextManager(),
+});
+
+// Add LLM instrumentations
+await registerLatitudeInstrumentations({
+  instrumentations: ["openai"],
+  tracerProvider: provider,
+});
+
+// Validate the setup
+Sentry.validateOpenTelemetrySetup();
+
+// LLM calls are now traced and sent to both Sentry and Latitude
+```
+
+**Adding context:** Use `capture()` if you want to add user IDs, session IDs, or tags to your traces (see [Using `capture()` for Context and Boundaries](#using-capture-for-context-and-boundaries)).
+
+**Required Sentry packages:** `@sentry/node`, `@sentry/opentelemetry`
+
+**Note:** See [Sentry's custom OTel setup documentation](https://docs.sentry.io/platforms/javascript/guides/node/opentelemetry/custom-setup/) for version-specific details.
+
+## Supported AI Providers
+
+| Identifier     | Package                           |
+| -------------- | --------------------------------- |
+| `"openai"`     | `openai`                          |
+| `"anthropic"`  | `@anthropic-ai/sdk`               |
+| `"bedrock"`    | `@aws-sdk/client-bedrock-runtime` |
+| `"cohere"`     | `cohere-ai`                       |
+| `"langchain"`  | `langchain`                       |
+| `"llamaindex"` | `llamaindex`                      |
+| `"togetherai"` | `together-ai`                     |
+| `"vertexai"`   | `@google-cloud/vertexai`          |
+| `"aiplatform"` | `@google-cloud/aiplatform`        |
+
+## Context Options
+
+`capture()` accepts these context options:
+
+| Option      | Type                      | OTel Attribute          | Description                  |
+| ----------- | ------------------------- | ----------------------- | ---------------------------- |
+| `name`      | `string`                  | `latitude.capture.name` | Name for the capture context |
+| `tags`      | `string[]`                | `latitude.tags`         | Tags for filtering traces    |
+| `metadata`  | `Record<string, unknown>` | `latitude.metadata`     | Arbitrary key-value metadata |
+| `sessionId` | `string`                  | `session.id`            | Group traces by session      |
+| `userId`    | `string`                  | `user.id`               | Associate traces with a user |
+
+## Configuration Options
+
+### Smart Filtering
+
+By default, only LLM-relevant spans are exported:
+
+```typescript
+new LatitudeSpanProcessor(apiKey, projectSlug, {
+  disableSmartFilter: true, // Export all spans
+});
+```
+
+### Redaction
+
+PII redaction is enabled by default for security-sensitive attributes only:
+
+**Redacted by default:**
+
+- HTTP authorization headers
+- HTTP cookies
+- HTTP API key headers (`x-api-key`)
+- Database statements
+
+```typescript
+new LatitudeSpanProcessor(apiKey, projectSlug, {
+  disableRedact: true, // Disable all redaction
+  redact: {
+    attributes: [/^password$/i, /secret/i], // Add custom patterns
+    mask: (attr, value) => "[REDACTED]",
   },
-})
+});
+```
 
-// Automatically instrumented
-const sdk = new Latitude('my-api-key', {
-  projectId: 'my-project-id',
-  versionUuid: 'my-version-uuid',
-})
+### Custom Filtering
 
-// Automatically instrumented
-const openai = new OpenAI({
-  apiKey: 'my-api-key',
-})
+```typescript
+new LatitudeSpanProcessor(apiKey, projectSlug, {
+  shouldExportSpan: (span) => span.attributes["custom"] === true,
+  blockedInstrumentationScopes: ["opentelemetry.instrumentation.fs"],
+});
 ```
 
-Find more [examples](https://docs.latitude.so/examples/sdk).
+## Environment Variables
+
+| Variable                 | Default                                                             | Description            |
+| ------------------------ | ------------------------------------------------------------------- | ---------------------- |
+| `LATITUDE_TELEMETRY_URL` | `http://localhost:3002` (dev) / `https://ingest.latitude.so` (prod) | OTLP exporter endpoint |
+
+## Troubleshooting
+
+### Spans not appearing in Latitude
 
-## Development
+1. **Check API key and project slug** — Must be non-empty strings
+2. **Verify instrumentations are registered** — Use `await registerLatitudeInstrumentations()`
+3. **Flush before exit** — Call `await latitude.flush()` or `await provider.forceFlush()`
+4. **Check smart filter** — Only LLM spans are exported by default. Use `disableSmartFilter: true` to export all spans
+5. **Ensure `capture()` wraps the code that creates spans** — `capture()` itself doesn't create spans; it only attaches context to spans created by instrumentations
 
-Requires npm `0.5.10` or higher.
+### No spans created inside `capture()`
+
+`capture()` only attaches context. You need:
+
+1. An active instrumentation (e.g., `@traceloop/instrumentation-openai`)
+2. That instrumentation to create spans for the operations inside your callback
+
+### Context not propagating
+
+Ensure you have a functioning OpenTelemetry context manager registered:
+
+```typescript
+import { AsyncLocalStorageContextManager } from "@opentelemetry/context-async-hooks";
+import { context } from "@opentelemetry/api";
+
+context.setGlobalContextManager(new AsyncLocalStorageContextManager());
+```
 
-- Install dependencies: `npm install`
-- Add [dev] dependencies: `npm install <package> [--save-dev]`
-- Run linter: `npm run lint`
-- Run formatter: `npm run format`
-- Run tests: `npm run test`
-- Build package: `npm run build`
+`initLatitude()` does this automatically. For shared-provider setups, your app's existing OTel setup should already have this.
 
 ## License
 
-The SDK is licensed under the [MIT License](https://opensource.org/licenses/MIT) - read the [LICENSE](/LICENSE) file for details.
+MIT