@mastra/core 1.18.1-alpha.0 → 1.19.0-alpha.2

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

@@ -1,317 +0,0 @@
-# Datadog exporter
-
-[Datadog](https://datadoghq.com/) is a comprehensive monitoring platform with dedicated LLM Observability features. The Datadog exporter sends your traces to Datadog's LLM Observability product, providing insights into model performance, token usage, and conversation flows.
-
-## Installation
-
-**npm**:
-
-```bash
-npm install @mastra/datadog@latest
-```
-
-**pnpm**:
-
-```bash
-pnpm add @mastra/datadog@latest
-```
-
-**Yarn**:
-
-```bash
-yarn add @mastra/datadog@latest
-```
-
-**Bun**:
-
-```bash
-bun add @mastra/datadog@latest
-```
-
-## Configuration
-
-### Prerequisites
-
-1. **Datadog Account**: Sign up at [datadoghq.com](https://datadoghq.com/) with LLM Observability enabled
-2. **API Key**: Get your API key from Datadog Organization Settings → API Keys
-3. **Environment Variables**: Set your credentials
-
-```bash
-DD_API_KEY=your-datadog-api-key
-DD_LLMOBS_ML_APP=my-llm-app
-DD_SITE=datadoghq.com  # Optional: defaults to datadoghq.com
-DD_ENV=production      # Optional: environment name
-```
-
-### 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 { DatadogExporter } from '@mastra/datadog'
-
-export const mastra = new Mastra({
-  observability: new Observability({
-    configs: {
-      datadog: {
-        serviceName: 'my-service',
-        exporters: [new DatadogExporter()],
-      },
-    },
-  }),
-})
-```
-
-### 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 { DatadogExporter } from '@mastra/datadog'
-
-export const mastra = new Mastra({
-  observability: new Observability({
-    configs: {
-      datadog: {
-        serviceName: 'my-service',
-        exporters: [
-          new DatadogExporter({
-            mlApp: process.env.DD_LLMOBS_ML_APP!,
-            apiKey: process.env.DD_API_KEY!,
-          }),
-        ],
-      },
-    },
-  }),
-})
-```
-
-## Configuration options
-
-### Complete Configuration
-
-```typescript
-new DatadogExporter({
-  // Required settings
-  mlApp: process.env.DD_LLMOBS_ML_APP!, // Groups traces under this ML app name
-  apiKey: process.env.DD_API_KEY!, // Required for agentless mode (default)
-
-  // Optional settings
-  site: 'datadoghq.com', // Datadog site (datadoghq.eu, us3.datadoghq.com, etc.)
-  service: 'my-service', // Service name (defaults to mlApp)
-  env: 'production', // Environment name
-  agentless: true, // true = direct HTTPS, false = local Datadog Agent
-
-  // Advanced settings
-  integrationsEnabled: false, // Enable dd-trace auto-instrumentation
-
-  // Diagnostic logging
-  logLevel: 'info', // debug | info | warn | error
-})
-```
-
-### With Local Datadog Agent
-
-If you have a Datadog Agent running locally, you can route traces through it instead of direct HTTPS:
-
-```typescript
-new DatadogExporter({
-  mlApp: process.env.DD_LLMOBS_ML_APP!,
-  agentless: false, // Use local Datadog Agent
-  env: 'production',
-})
-```
-
-Note: When using agent mode, the API key is read from the local agent's configuration.
-
-## Span type mapping
-
-Mastra span types are automatically mapped to Datadog LLMObs span kinds:
-
-| Mastra SpanType      | Datadog Kind |
-| -------------------- | ------------ |
-| `AGENT_RUN`          | `agent`      |
-| `MODEL_GENERATION`   | `workflow`   |
-| `MODEL_STEP`         | `llm`        |
-| `TOOL_CALL`          | `tool`       |
-| `MCP_TOOL_CALL`      | `tool`       |
-| `WORKFLOW_RUN`       | `workflow`   |
-| Other workflow types | `task`       |
-| `GENERIC`            | `task`       |
-
-Other/future Mastra span types will default to 'task' when mapped unless specified.
-
-## Application Performance Monitoring
-
-The sections above cover Mastra's [LLM Observability](https://docs.datadoghq.com/llm_observability/) integration. To trace your Mastra HTTP server routes (request latency, error tracking, service maps), use `dd-trace` directly for Datadog Application Performance Monitoring (APM).
-
-### Prerequisites
-
-1. **Datadog Agent**: Install a [Datadog Agent](https://docs.datadoghq.com/agent/) on the same host or accessible via network. The agent receives traces from `dd-trace` on `localhost:8126` and forwards them to Datadog. Follow the [agent installation guide](https://docs.datadoghq.com/agent/) to set it up.
-
-2. **dd-trace package**: Install the tracing library in your project:
-
-   **npm**:
-
-   ```bash
-   npm install dd-trace
-   ```
-
-   **pnpm**:
-
-   ```bash
-   pnpm add dd-trace
-   ```
-
-   **Yarn**:
-
-   ```bash
-   yarn add dd-trace
-   ```
-
-   **Bun**:
-
-   ```bash
-   bun add dd-trace
-   ```
-
-> **Note:** APM traces always route through the Datadog Agent. This is different from LLM Observability, which supports agentless mode (direct HTTPS to Datadog).
-
-### APM only
-
-Import and initialize `dd-trace` at the top of your entry file, before any other imports:
-
-```typescript
-import tracer from 'dd-trace'
-
-tracer.init({
-  service: process.env.DD_SERVICE || 'my-mastra-app',
-  env: process.env.DD_ENV || 'production',
-  version: process.env.DD_VERSION,
-})
-
-import { Mastra } from '@mastra/core'
-
-export const mastra = new Mastra({
-  bundler: {
-    externals: [
-      'dd-trace',
-      '@datadog/native-metrics',
-      '@datadog/native-appsec',
-      '@datadog/native-iast-taint-tracking',
-      '@datadog/pprof',
-    ],
-  },
-})
-```
-
-Set the tracer metadata environment variables:
-
-```bash
-DD_SERVICE=my-mastra-app
-DD_ENV=production
-DD_VERSION=1.0.0
-```
-
-`dd-trace` auto-instruments popular HTTP frameworks, including those supported by Mastra's [server adapters](https://mastra.ai/docs/server/server-adapters). Inbound requests, outbound HTTP calls, and database queries appear as APM traces in Datadog.
-
-### APM and LLM Observability
-
-Import and initialize `dd-trace` before creating the Mastra instance. The `DatadogExporter` detects the existing tracer and skips re-initialization, adding LLM Observability on top of your APM setup:
-
-```typescript
-import tracer from 'dd-trace'
-
-tracer.init({
-  service: process.env.DD_SERVICE || 'my-mastra-app',
-  env: process.env.DD_ENV || 'production',
-  version: process.env.DD_VERSION,
-})
-
-import { Mastra } from '@mastra/core'
-import { Observability } from '@mastra/observability'
-import { DatadogExporter } from '@mastra/datadog'
-
-export const mastra = new Mastra({
-  observability: new Observability({
-    configs: {
-      datadog: {
-        serviceName: 'my-mastra-app',
-        exporters: [
-          new DatadogExporter({
-            mlApp: process.env.DD_LLMOBS_ML_APP!,
-            apiKey: process.env.DD_API_KEY!,
-          }),
-        ],
-      },
-    },
-  }),
-  bundler: {
-    externals: [
-      'dd-trace',
-      '@datadog/native-metrics',
-      '@datadog/native-appsec',
-      '@datadog/native-iast-taint-tracking',
-      '@datadog/pprof',
-    ],
-  },
-})
-```
-
-```bash
-DD_SERVICE=my-mastra-app
-DD_ENV=production
-DD_VERSION=1.0.0
-DD_API_KEY=your-datadog-api-key
-DD_LLMOBS_ML_APP=my-llm-app
-```
-
-Server routes appear as APM traces and LLM calls appear as LLM Observability spans, all under the same service in Datadog.
-
-> **Note:** Import and initialize `dd-trace` before all other modules. This allows its auto-instrumentation to patch HTTP, database, and framework libraries at load time.
-
-## Troubleshooting
-
-### Native module ABI mismatch
-
-If you see errors like:
-
-```text
-Error: No native build was found for runtime=node abi=137 platform=linuxglibc arch=x64
-```
-
-This indicates a Node.js version compatibility issue with `dd-trace`'s native modules. These native modules are **optional** and provide performance monitoring features.
-
-**Solutions:**
-
-1. **Use Node.js 22.x**: Native modules have the best compatibility with Node.js 22.x.
-
-2. **Ignore native module warnings**: The native modules (`@datadog/native-metrics`, `@datadog/native-appsec`, etc.) are optional. If they fail to load, core tracing functionality still works.
-
-### Bundler externals configuration
-
-When using bundlers like esbuild, webpack, or the Mastra CLI bundler, you may need to mark `dd-trace` and its dependencies as external:
-
-```typescript
-export const mastra = new Mastra({
-  bundler: {
-    externals: [
-      'dd-trace',
-      '@datadog/native-metrics',
-      '@datadog/native-appsec',
-      '@datadog/native-iast-taint-tracking',
-      '@datadog/pprof',
-    ],
-  },
-})
-```
-
-## Related
-
-- [Tracing overview](https://mastra.ai/docs/observability/tracing/overview)
-- [Datadog LLM Observability documentation](https://docs.datadoghq.com/llm_observability/)
-- [Datadog APM documentation](https://docs.datadoghq.com/tracing/)

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

@@ -1,209 +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 **don't 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)