@mastra/core 1.18.0 → 1.18.1-alpha.1

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

@@ -1,126 +0,0 @@
-# Braintrust exporter
-
-[Braintrust](https://www.braintrust.dev/) is an evaluation and monitoring platform that helps you measure and improve LLM application quality. The Braintrust exporter sends your traces to Braintrust, enabling systematic evaluation, scoring, and experimentation.
-
-## Installation
-
-**npm**:
-
-```bash
-npm install @mastra/braintrust@latest
-```
-
-**pnpm**:
-
-```bash
-pnpm add @mastra/braintrust@latest
-```
-
-**Yarn**:
-
-```bash
-yarn add @mastra/braintrust@latest
-```
-
-**Bun**:
-
-```bash
-bun add @mastra/braintrust@latest
-```
-
-## Configuration
-
-### Prerequisites
-
-1. **Braintrust Account**: Sign up at [braintrust.dev](https://www.braintrust.dev/)
-2. **Project**: Create or select a project for your traces
-3. **API Key**: Generate in Braintrust Settings → API Keys
-4. **Environment Variables**: Set your credentials:
-
-```bash
-BRAINTRUST_API_KEY=sk-xxxxxxxxxxxxxxxx
-
-# Optional
-BRAINTRUST_ENDPOINT=https://api.braintrust.dev  # Custom endpoint if needed
-```
-
-### 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 { BraintrustExporter } from '@mastra/braintrust'
-
-export const mastra = new Mastra({
-  observability: new Observability({
-    configs: {
-      braintrust: {
-        serviceName: 'my-service',
-        exporters: [new BraintrustExporter()],
-      },
-    },
-  }),
-})
-```
-
-### 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 { BraintrustExporter } from '@mastra/braintrust'
-
-export const mastra = new Mastra({
-  observability: new Observability({
-    configs: {
-      braintrust: {
-        serviceName: 'my-service',
-        exporters: [
-          new BraintrustExporter({
-            apiKey: process.env.BRAINTRUST_API_KEY,
-            projectName: 'my-project',
-          }),
-        ],
-      },
-    },
-  }),
-})
-```
-
-### Complete Configuration
-
-```typescript
-new BraintrustExporter({
-  // Required
-  apiKey: process.env.BRAINTRUST_API_KEY!,
-
-  // Optional settings
-  projectName: 'my-project', // Default: 'mastra-tracing'
-  endpoint: 'https://api.braintrust.dev', // Custom endpoint if needed
-  logLevel: 'info', // Diagnostic logging: debug | info | warn | error
-})
-```
-
-## Querying Braintrust with returned `spanId`
-
-For Braintrust, use `spanId` as the root span identifier when searching for traces because Braintrust root-span queries are typically faster than trace-id queries.
-
-```typescript
-const result = await agent.stream('Summarize this ticket')
-
-console.log('Mastra trace ID:', result.traceId)
-console.log('Braintrust root span ID:', result.spanId)
-
-// Use result.spanId in your Braintrust lookup/query path
-```
-
-The same applies to `agent.generate()` and workflow run results (`run.start()`, `run.stream()` final state, `run.resume()`).
-
-## Related
-
-- [Tracing Overview](https://mastra.ai/docs/observability/tracing/overview)
-- [Braintrust Documentation](https://www.braintrust.dev/docs)

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

@@ -1,127 +0,0 @@
-# Cloud exporter
-
-The `CloudExporter` sends traces to Mastra Cloud for centralized monitoring and team collaboration. It's automatically enabled when using the default observability configuration with a valid access token.
-
-## Configuration
-
-### Prerequisites
-
-1. **Mastra Cloud Account**: Sign up at [cloud.mastra.ai](https://cloud.mastra.ai)
-2. **Mastra Cloud Project**: Create a project in Mastra Cloud. Traces are scoped per project, so even if you only want observability, you need a project to act as the destination for your traces.
-3. **Access Token**: Generate in your project's sidebar under **Project Settings → Access Tokens**
-4. **Environment Variables**: Set your credentials:
-
-```bash
-MASTRA_CLOUD_ACCESS_TOKEN=mst_xxxxxxxxxxxxxxxx
-```
-
-### Basic Setup
-
-```typescript
-import { Mastra } from '@mastra/core'
-import { Observability, CloudExporter } from '@mastra/observability'
-
-export const mastra = new Mastra({
-  observability: new Observability({
-    configs: {
-      production: {
-        serviceName: 'my-service',
-        exporters: [
-          new CloudExporter(), // Uses MASTRA_CLOUD_ACCESS_TOKEN env var
-        ],
-      },
-    },
-  }),
-})
-```
-
-### Recommended Configuration
-
-Include CloudExporter in your observability configuration:
-
-```typescript
-import { Mastra } from '@mastra/core'
-import {
-  Observability,
-  DefaultExporter,
-  CloudExporter,
-  SensitiveDataFilter,
-} from '@mastra/observability'
-
-export const mastra = new Mastra({
-  observability: new Observability({
-    configs: {
-      default: {
-        serviceName: 'mastra',
-        exporters: [
-          new DefaultExporter(),
-          new CloudExporter(), // Sends traces to Mastra Cloud (requires MASTRA_CLOUD_ACCESS_TOKEN)
-        ],
-        spanOutputProcessors: [new SensitiveDataFilter()],
-      },
-    },
-  }),
-})
-```
-
-### Complete Configuration
-
-```typescript
-new CloudExporter({
-  // Optional - defaults to env var
-  accessToken: process.env.MASTRA_CLOUD_ACCESS_TOKEN,
-
-  // Optional - for self-hosted Mastra Cloud
-  endpoint: 'https://cloud.your-domain.com',
-
-  // Batching configuration
-  maxBatchSize: 1000, // Max spans per batch
-  maxBatchWaitMs: 5000, // Max wait before sending batch
-
-  // Diagnostic logging
-  logLevel: 'info', // debug | info | warn | error
-})
-```
-
-## Viewing traces
-
-### Mastra Cloud Dashboard
-
-1. Navigate to [cloud.mastra.ai](https://cloud.mastra.ai)
-
-2. Select the project associated with your access token
-
-3. Go to **Observability → Traces**
-
-4. Use filters to find specific traces:
-
-   - Service name
-   - Time range
-   - Trace ID
-   - Error status
-
-> **Note:** Traces are scoped to the project that issued the access token. To view traces, make sure you're viewing the same project you generated the token from.
-
-### Features
-
-- **Trace Timeline** - Visual execution flow
-- **Span Details** - Inputs, outputs, metadata
-- **Performance Metrics** - Latency, token usage
-- **Team Collaboration** - Share trace links
-
-## Performance
-
-> **Info:** CloudExporter uses intelligent batching to optimize network usage. Traces are buffered and sent in batches, reducing overhead while maintaining near real-time visibility.
-
-### Batching Behavior
-
-- Traces are batched up to `maxBatchSize` (default: 1000)
-- Batches are sent when full or after `maxBatchWaitMs` (default: 5 seconds)
-- Failed batches are retried with exponential backoff
-- Graceful degradation if Mastra Cloud is unreachable
-
-## Related
-
-- [Tracing Overview](https://mastra.ai/docs/observability/tracing/overview)
-- [DefaultExporter](https://mastra.ai/docs/observability/tracing/exporters/default)
-- [Mastra Cloud Documentation](https://mastra.ai/docs/mastra-cloud/overview)

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/)