@mastra/core 1.6.0 → 1.7.0-alpha.0

package/dist/docs/references/docs-observability-tracing-exporters-default.md

@@ -1,211 +0,0 @@
-# Default Exporter
-
-The `DefaultExporter` persists traces to your configured storage backend, making them accessible through Studio. It's automatically enabled when using the default observability configuration and requires no external services.
-
-> **Production Observability:** Observability data can quickly overwhelm general-purpose databases in production. For high-traffic applications, we recommend using **ClickHouse** for the observability storage domain via [composite storage](https://mastra.ai/reference/storage/composite). See [Production Recommendations](#production-recommendations) for details.
-
-## Configuration
-
-### Prerequisites
-
-1. **Storage Backend**: Configure a storage provider (libSQL, PostgreSQL, etc.)
-2. **Studio**: Install for viewing traces locally
-
-### Basic Setup
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { Observability, DefaultExporter } from "@mastra/observability";
-import { LibSQLStore } from "@mastra/libsql";
-
-export const mastra = new Mastra({
-  storage: new LibSQLStore({
-    id: 'mastra-storage',
-    url: "file:./mastra.db", // Required for trace persistence
-  }),
-  observability: new Observability({
-    configs: {
-      local: {
-        serviceName: "my-service",
-        exporters: [new DefaultExporter()],
-      },
-    },
-  }),
-});
-```
-
-### Recommended Configuration
-
-Include DefaultExporter in your observability configuration:
-
-```typescript
-import { Mastra } from "@mastra/core";
-import {
-  Observability,
-  DefaultExporter,
-  CloudExporter,
-  SensitiveDataFilter,
-} from "@mastra/observability";
-import { LibSQLStore } from "@mastra/libsql";
-
-export const mastra = new Mastra({
-  storage: new LibSQLStore({
-    id: 'mastra-storage',
-    url: "file:./mastra.db",
-  }),
-  observability: new Observability({
-    configs: {
-      default: {
-        serviceName: "mastra",
-        exporters: [
-          new DefaultExporter(), // Persists traces to storage for Mastra Studio
-          new CloudExporter(), // Sends traces to Mastra Cloud (requires MASTRA_CLOUD_ACCESS_TOKEN)
-        ],
-        spanOutputProcessors: [
-          new SensitiveDataFilter(),
-        ],
-      },
-    },
-  }),
-});
-```
-
-## Viewing Traces
-
-### Studio
-
-Access your traces through Studio:
-
-1. Start Studio
-2. Navigate to Observability
-3. Filter and search your local traces
-4. Inspect detailed span information
-
-## Tracing Strategies
-
-DefaultExporter automatically selects the optimal tracing strategy based on your storage provider. You can also override this selection if needed.
-
-### Available Strategies
-
-| Strategy               | Description                                               | Use Case                            |
-| ---------------------- | --------------------------------------------------------- | ----------------------------------- |
-| **realtime**           | Process each event immediately                            | Development, debugging, low traffic |
-| **batch-with-updates** | Buffer events and batch write with full lifecycle support | Low volume Production               |
-| **insert-only**        | Only process completed spans, ignore updates              | High volume Production              |
-
-### Strategy Configuration
-
-```typescript
-new DefaultExporter({
-  strategy: "auto", // Default - let storage provider decide
-  // or explicitly set:
-  // strategy: 'realtime' | 'batch-with-updates' | 'insert-only'
-
-  // Batching configuration (applies to both batch-with-updates and insert-only)
-  maxBatchSize: 1000, // Max spans per batch
-  maxBatchWaitMs: 5000, // Max wait before flushing
-  maxBufferSize: 10000, // Max spans to buffer
-});
-```
-
-## Storage Provider Support
-
-Different storage providers support different tracing strategies. Some providers support observability for production workloads, while others are intended primarily for local development.
-
-If you set the strategy to `'auto'`, the `DefaultExporter` automatically selects the optimal strategy for the storage provider. If you set the strategy to a mode that the storage provider doesn't support, you will get an error message.
-
-### Providers with Observability Support
-
-| Storage Provider                                                 | Preferred Strategy | Supported Strategies            | Recommended Use                       |
-| ---------------------------------------------------------------- | ------------------ | ------------------------------- | ------------------------------------- |
-| **ClickHouse** (`@mastra/clickhouse`)                            | insert-only        | insert-only                     | Production (high-volume)              |
-| **[PostgreSQL](https://mastra.ai/reference/storage/postgresql)** | batch-with-updates | batch-with-updates, insert-only | Production (low volume)               |
-| **[MSSQL](https://mastra.ai/reference/storage/mssql)**           | batch-with-updates | batch-with-updates, insert-only | Production (low volume)               |
-| **[MongoDB](https://mastra.ai/reference/storage/mongodb)**       | batch-with-updates | batch-with-updates, insert-only | Production (low volume)               |
-| **[libSQL](https://mastra.ai/reference/storage/libsql)**         | batch-with-updates | batch-with-updates, insert-only | Default storage, good for development |
-
-### Providers without Observability Support
-
-The following storage providers **do not support** the observability domain. If you're using one of these providers and need observability, use [composite storage](https://mastra.ai/reference/storage/composite) to route observability data to a supported provider:
-
-- [Convex](https://mastra.ai/reference/storage/convex)
-- [DynamoDB](https://mastra.ai/reference/storage/dynamodb)
-- [Cloudflare D1](https://mastra.ai/reference/storage/cloudflare-d1)
-- [Cloudflare Durable Objects](https://mastra.ai/reference/storage/cloudflare)
-- [Upstash](https://mastra.ai/reference/storage/upstash)
-- [LanceDB](https://mastra.ai/reference/storage/lance)
-
-### Strategy Benefits
-
-- **realtime**: Immediate visibility, best for debugging
-- **batch-with-updates**: 10-100x throughput improvement, full span lifecycle
-- **insert-only**: Additional 70% reduction in database operations, perfect for analytics
-
-## Production Recommendations
-
-Observability data grows quickly in production environments. A single agent interaction can generate hundreds of spans, and high-traffic applications can produce thousands of traces per day. Most general-purpose databases aren't optimized for this write-heavy, append-only workload.
-
-### Recommended: ClickHouse for High-Volume Production
-
-[ClickHouse](https://mastra.ai/reference/storage/composite) is a columnar database designed for high-volume analytics workloads. It's the recommended choice for production observability because:
-
-- **Optimized for writes**: Handles millions of inserts per second
-- **Efficient compression**: Reduces storage costs for trace data
-- **Fast queries**: Columnar storage enables quick trace lookups and aggregations
-- **Time-series native**: Built-in support for time-based data retention and partitioning
-
-### Using Composite Storage
-
-If you're using a provider without observability support (like Convex or DynamoDB) or want to optimize performance, use [composite storage](https://mastra.ai/reference/storage/composite) to route observability data to ClickHouse while keeping other data in your primary database.
-
-## Batching Behavior
-
-### Flush Triggers
-
-For both batch strategies (`batch-with-updates` and `insert-only`), traces are flushed to storage when any of these conditions are met:
-
-1. **Size trigger**: Buffer reaches `maxBatchSize` spans
-2. **Time trigger**: `maxBatchWaitMs` elapsed since first event
-3. **Emergency flush**: Buffer approaches `maxBufferSize` limit
-4. **Shutdown**: Force flush all pending events
-
-### Error Handling
-
-The DefaultExporter includes robust error handling for production use:
-
-- **Retry Logic**: Exponential backoff (500ms, 1s, 2s, 4s)
-- **Transient Failures**: Automatic retry with backoff
-- **Persistent Failures**: Drop batch after 4 failed attempts
-- **Buffer Overflow**: Prevent memory issues during storage outages
-
-### Configuration Examples
-
-```typescript
-// Zero config - recommended for most users
-new DefaultExporter();
-
-// Development override
-new DefaultExporter({
-  strategy: "realtime", // Immediate visibility for debugging
-});
-
-// High-throughput production
-new DefaultExporter({
-  maxBatchSize: 2000, // Larger batches
-  maxBatchWaitMs: 10000, // Wait longer to fill batches
-  maxBufferSize: 50000, // Handle longer outages
-});
-
-// Low-latency production
-new DefaultExporter({
-  maxBatchSize: 100, // Smaller batches
-  maxBatchWaitMs: 1000, // Flush quickly
-});
-```
-
-## Related
-
-- [Tracing Overview](https://mastra.ai/docs/observability/tracing/overview)
-- [CloudExporter](https://mastra.ai/docs/observability/tracing/exporters/cloud)
-- [Composite Storage](https://mastra.ai/reference/storage/composite) - Combine multiple storage providers
-- [Storage Configuration](https://mastra.ai/docs/memory/storage)

package/dist/docs/references/docs-observability-tracing-exporters-laminar.md

@@ -1,100 +0,0 @@
-# Laminar Exporter
-
-[Laminar](https://laminar.sh/) is an open-source platform for engineering LLM products. The Laminar exporter sends your Mastra traces to Laminar via OTLP/HTTP (protobuf), with Laminar-native span attributes for correct rendering (paths, inputs/outputs, tags, metadata).
-
-## Installation
-
-**npm**:
-
-```bash
-npm install @mastra/laminar@beta
-```
-
-**pnpm**:
-
-```bash
-pnpm add @mastra/laminar@beta
-```
-
-**Yarn**:
-
-```bash
-yarn add @mastra/laminar@beta
-```
-
-**Bun**:
-
-```bash
-bun add @mastra/laminar@beta
-```
-
-## Configuration
-
-### Prerequisites
-
-1. **Laminar Project**: Create/select a project in Laminar
-2. **Project API Key**: Copy from Laminar Project Settings
-3. **Environment Variables**: Set your credentials
-
-```bash
-# Required
-LMNR_PROJECT_API_KEY=lmnr_...
-
-# Optional
-LMNR_BASE_URL=https://api.lmnr.ai
-LAMINAR_ENDPOINT=https://api.lmnr.ai/v1/traces
-```
-
-### Zero-Config Setup
-
-With environment variables set, use the exporter with no configuration:
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { Observability } from "@mastra/observability";
-import { LaminarExporter } from "@mastra/laminar";
-
-export const mastra = new Mastra({
-  observability: new Observability({
-    configs: {
-      laminar: {
-        serviceName: "my-service",
-        exporters: [new LaminarExporter()],
-      },
-    },
-  }),
-});
-```
-
-### Explicit Configuration
-
-You can also pass credentials directly (takes precedence over environment variables):
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { Observability } from "@mastra/observability";
-import { LaminarExporter } from "@mastra/laminar";
-
-export const mastra = new Mastra({
-  observability: new Observability({
-    configs: {
-      laminar: {
-        serviceName: "my-service",
-        exporters: [
-          new LaminarExporter({
-            apiKey: process.env.LMNR_PROJECT_API_KEY!,
-            baseUrl: process.env.LMNR_BASE_URL, // Optional
-            endpoint: process.env.LAMINAR_ENDPOINT, // Optional
-            realtime: process.env.NODE_ENV === "development", // Optional
-          }),
-        ],
-      },
-    },
-  }),
-});
-```
-
-## Related
-
-- [Tracing Overview](https://mastra.ai/docs/observability/tracing/overview)
-- [Laminar Documentation](https://docs.laminar.sh)

package/dist/docs/references/docs-observability-tracing-exporters-langfuse.md

@@ -1,217 +0,0 @@
-# Langfuse Exporter
-
-[Langfuse](https://langfuse.com/) is an open-source observability platform specifically designed for LLM applications. The Langfuse exporter sends your traces to Langfuse, providing detailed insights into model performance, token usage, and conversation flows.
-
-## Installation
-
-**npm**:
-
-```bash
-npm install @mastra/langfuse@latest
-```
-
-**pnpm**:
-
-```bash
-pnpm add @mastra/langfuse@latest
-```
-
-**Yarn**:
-
-```bash
-yarn add @mastra/langfuse@latest
-```
-
-**Bun**:
-
-```bash
-bun add @mastra/langfuse@latest
-```
-
-## Configuration
-
-### Prerequisites
-
-1. **Langfuse Account**: Sign up at [cloud.langfuse.com](https://cloud.langfuse.com) or deploy self-hosted
-2. **API Keys**: Create public/secret key pair in Langfuse Settings → API Keys
-3. **Environment Variables**: Set your credentials
-
-```bash
-LANGFUSE_PUBLIC_KEY=pk-lf-xxxxxxxxxxxx
-LANGFUSE_SECRET_KEY=sk-lf-xxxxxxxxxxxx
-LANGFUSE_BASE_URL=https://cloud.langfuse.com  # Or your self-hosted URL
-```
-
-### Zero-Config Setup
-
-With environment variables set, use the exporter with no configuration:
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { Observability } from "@mastra/observability";
-import { LangfuseExporter } from "@mastra/langfuse";
-
-export const mastra = new Mastra({
-  observability: new Observability({
-    configs: {
-      langfuse: {
-        serviceName: "my-service",
-        exporters: [new LangfuseExporter()],
-      },
-    },
-  }),
-});
-```
-
-### Explicit Configuration
-
-You can also pass credentials directly (takes precedence over environment variables):
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { Observability } from "@mastra/observability";
-import { LangfuseExporter } from "@mastra/langfuse";
-
-export const mastra = new Mastra({
-  observability: new Observability({
-    configs: {
-      langfuse: {
-        serviceName: "my-service",
-        exporters: [
-          new LangfuseExporter({
-            publicKey: process.env.LANGFUSE_PUBLIC_KEY!,
-            secretKey: process.env.LANGFUSE_SECRET_KEY!,
-            baseUrl: process.env.LANGFUSE_BASE_URL,
-            options: {
-              environment: process.env.NODE_ENV,
-            },
-          }),
-        ],
-      },
-    },
-  }),
-});
-```
-
-## Configuration Options
-
-### Realtime vs Batch Mode
-
-The Langfuse exporter supports two modes for sending traces:
-
-#### Realtime Mode (Development)
-
-Traces appear immediately in Langfuse dashboard, ideal for debugging:
-
-```typescript
-new LangfuseExporter({
-  publicKey: process.env.LANGFUSE_PUBLIC_KEY!,
-  secretKey: process.env.LANGFUSE_SECRET_KEY!,
-  realtime: true, // Flush after each event
-});
-```
-
-#### Batch Mode (Production)
-
-Better performance with automatic batching:
-
-```typescript
-new LangfuseExporter({
-  publicKey: process.env.LANGFUSE_PUBLIC_KEY!,
-  secretKey: process.env.LANGFUSE_SECRET_KEY!,
-  realtime: false, // Default - batch traces
-});
-```
-
-### Complete Configuration
-
-```typescript
-new LangfuseExporter({
-  // Required credentials
-  publicKey: process.env.LANGFUSE_PUBLIC_KEY!,
-  secretKey: process.env.LANGFUSE_SECRET_KEY!,
-
-  // Optional settings
-  baseUrl: process.env.LANGFUSE_BASE_URL, // Default: https://cloud.langfuse.com
-  realtime: process.env.NODE_ENV === "development", // Dynamic mode selection
-  logLevel: "info", // Diagnostic logging: debug | info | warn | error
-
-  // Langfuse-specific options
-  options: {
-    environment: process.env.NODE_ENV, // Shows in UI for filtering
-    version: process.env.APP_VERSION, // Track different versions
-    release: process.env.GIT_COMMIT, // Git commit hash
-  },
-});
-```
-
-## Prompt Linking
-
-You can link LLM generations to prompts stored in [Langfuse Prompt Management](https://langfuse.com/docs/prompt-management). This enables version tracking and metrics for your prompts.
-
-### Using the Helper (Recommended)
-
-Use `withLangfusePrompt` with `buildTracingOptions` for the cleanest API:
-
-```typescript
-import { Agent } from "@mastra/core/agent";
-import { buildTracingOptions } from "@mastra/observability";
-import { withLangfusePrompt } from "@mastra/langfuse";
-import { Langfuse } from "langfuse";
-
-// Reads credentials from LANGFUSE_SECRET_KEY, LANGFUSE_PUBLIC_KEY, LANGFUSE_BASE_URL env vars
-const langfuse = new Langfuse();
-
-// Fetch the prompt from Langfuse Prompt Management
-const prompt = await langfuse.getPrompt("customer-support");
-
-export const supportAgent = new Agent({
-  name: "support-agent",
-  instructions: prompt.prompt, // Use the prompt text from Langfuse
-  model: "openai/gpt-4o",
-  defaultGenerateOptions: {
-    tracingOptions: buildTracingOptions(withLangfusePrompt(prompt)),
-  },
-});
-```
-
-The `withLangfusePrompt` helper automatically extracts `name`, `version`, and `id` from the Langfuse prompt object.
-
-### Manual Fields
-
-You can also pass manual fields if you're not using the Langfuse SDK:
-
-```typescript
-const tracingOptions = buildTracingOptions(
-  withLangfusePrompt({ name: "my-prompt", version: 1 }),
-);
-
-// Or with just an ID
-const tracingOptions = buildTracingOptions(
-  withLangfusePrompt({ id: "prompt-uuid-12345" }),
-);
-```
-
-### Prompt Object Fields
-
-The prompt object supports these fields:
-
-| Field     | Type   | Description                        |
-| --------- | ------ | ---------------------------------- |
-| `name`    | string | The prompt name in Langfuse        |
-| `version` | number | The prompt version number          |
-| `id`      | string | The prompt UUID for direct linking |
-
-You can link prompts using either:
-
-- `id` alone (the UUID uniquely identifies a prompt version)
-- `name` + `version` together
-- All three fields
-
-When set on a `MODEL_GENERATION` span, the Langfuse exporter automatically links the generation to the corresponding prompt.
-
-## Related
-
-- [Tracing Overview](https://mastra.ai/docs/observability/tracing/overview)
-- [Langfuse Documentation](https://langfuse.com/docs)
-- [Langfuse Prompt Management](https://langfuse.com/docs/prompt-management)