@mastra/mcp-docs-server 1.0.0-beta.9 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +3 -1
- package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +3 -1
- package/.docs/organized/changelogs/%40internal%2Fplayground.md +60 -0
- package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +15 -15
- package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +3 -1
- package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +287 -287
- package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +302 -302
- package/.docs/organized/changelogs/%40mastra%2Fastra.md +53 -53
- package/.docs/organized/changelogs/%40mastra%2Fauth.md +38 -0
- package/.docs/organized/changelogs/%40mastra%2Fchroma.md +66 -66
- package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +522 -212
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +239 -239
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +439 -234
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +450 -211
- package/.docs/organized/changelogs/%40mastra%2Fcodemod.md +202 -0
- package/.docs/organized/changelogs/%40mastra%2Fconvex.md +448 -22
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +348 -348
- package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +60 -60
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +287 -287
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +106 -106
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +90 -90
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +86 -86
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +221 -221
- package/.docs/organized/changelogs/%40mastra%2Fduckdb.md +70 -0
- package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +403 -225
- package/.docs/organized/changelogs/%40mastra%2Felasticsearch.md +72 -0
- package/.docs/organized/changelogs/%40mastra%2Fevals.md +145 -145
- package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +54 -0
- package/.docs/organized/changelogs/%40mastra%2Flance.md +456 -226
- package/.docs/organized/changelogs/%40mastra%2Flibsql.md +625 -229
- package/.docs/organized/changelogs/%40mastra%2Floggers.md +71 -71
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +245 -245
- package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +28 -28
- package/.docs/organized/changelogs/%40mastra%2Fmcp.md +281 -281
- package/.docs/organized/changelogs/%40mastra%2Fmemory.md +354 -156
- package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +545 -212
- package/.docs/organized/changelogs/%40mastra%2Fmssql.md +481 -202
- package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +194 -194
- package/.docs/organized/changelogs/%40mastra%2Fpg.md +781 -235
- package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +198 -198
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +282 -282
- package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +163 -163
- package/.docs/organized/changelogs/%40mastra%2Frag.md +310 -310
- package/.docs/organized/changelogs/%40mastra%2Freact.md +328 -237
- package/.docs/organized/changelogs/%40mastra%2Fs3vectors.md +64 -0
- package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +160 -0
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +230 -230
- package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +57 -57
- package/.docs/organized/changelogs/%40mastra%2Fupstash.md +479 -232
- package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +53 -53
- package/.docs/organized/changelogs/%40mastra%2Fvoice-azure.md +45 -45
- package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +45 -45
- package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +47 -47
- package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +110 -110
- package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +15 -0
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +98 -0
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +54 -54
- package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +46 -46
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai-realtime.md +93 -93
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +47 -47
- package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +45 -45
- package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +45 -45
- package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +45 -45
- package/.docs/organized/changelogs/create-mastra.md +219 -219
- package/.docs/organized/changelogs/mastra.md +276 -276
- package/.docs/organized/code-examples/a2a.md +2 -2
- package/.docs/organized/code-examples/agent-v6.md +221 -0
- package/.docs/organized/code-examples/agui.md +4 -4
- package/.docs/organized/code-examples/ai-elements.md +3 -3
- package/.docs/organized/code-examples/ai-sdk-useChat.md +2 -2
- package/.docs/organized/code-examples/ai-sdk-v5.md +3 -3
- package/.docs/organized/code-examples/assistant-ui.md +5 -5
- package/.docs/organized/code-examples/bird-checker-with-express.md +1 -1
- package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +2 -2
- package/.docs/organized/code-examples/bird-checker-with-nextjs.md +3 -3
- package/.docs/organized/code-examples/client-side-tools.md +4 -4
- package/.docs/organized/code-examples/crypto-chatbot.md +5 -5
- package/.docs/organized/code-examples/experimental-auth-weather-agent.md +1 -1
- package/.docs/organized/code-examples/fireworks-r1.md +2 -2
- package/.docs/organized/code-examples/heads-up-game.md +7 -7
- package/.docs/organized/code-examples/inngest.md +1075 -0
- package/.docs/organized/code-examples/mcp-configuration.md +1 -1
- package/.docs/organized/code-examples/mcp-server-adapters.md +2 -2
- package/.docs/organized/code-examples/memory-per-resource-example.md +3 -3
- package/.docs/organized/code-examples/memory-todo-agent.md +1 -1
- package/.docs/organized/code-examples/memory-with-context.md +1 -1
- package/.docs/organized/code-examples/memory-with-processors.md +1 -1
- package/.docs/organized/code-examples/openapi-spec-writer.md +3 -3
- package/.docs/organized/code-examples/quick-start.md +1 -5
- package/.docs/organized/code-examples/server-app-access.md +2 -2
- package/.docs/organized/code-examples/server-express-adapter.md +1 -1
- package/.docs/organized/code-examples/server-fastify-adapter.md +83 -0
- package/.docs/organized/code-examples/server-hono-adapter.md +2 -2
- package/.docs/organized/code-examples/server-koa-adapter.md +94 -0
- package/.docs/organized/code-examples/stock-price-tool.md +21 -2
- package/.docs/organized/code-examples/workflow-ai-recruiter.md +1 -1
- package/.docs/organized/code-examples/workflow-with-inline-steps.md +1 -1
- package/.docs/organized/code-examples/workflow-with-memory.md +1 -1
- package/.docs/organized/code-examples/workflow-with-separate-steps.md +1 -1
- package/.docs/organized/code-examples/workflow-with-suspend-resume.md +1 -1
- package/.docs/raw/agents/adding-voice.mdx +24 -6
- package/.docs/raw/agents/agent-approval.mdx +209 -12
- package/.docs/raw/agents/agent-memory.mdx +36 -32
- package/.docs/raw/agents/guardrails.mdx +105 -56
- package/.docs/raw/agents/network-approval.mdx +281 -0
- package/.docs/raw/agents/networks.mdx +69 -13
- package/.docs/raw/agents/overview.mdx +43 -25
- package/.docs/raw/agents/processors.mdx +234 -17
- package/.docs/raw/agents/structured-output.mdx +78 -8
- package/.docs/raw/agents/using-tools.mdx +67 -6
- package/.docs/raw/course/01-first-agent/07-creating-your-agent.md +1 -2
- package/.docs/raw/course/01-first-agent/12-connecting-tool-to-agent.md +1 -1
- package/.docs/raw/course/01-first-agent/16-adding-memory-to-agent.md +1 -2
- package/.docs/raw/course/02-agent-tools-mcp/05-updating-your-agent.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/10-updating-agent-instructions-zapier.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/16-updating-agent-instructions-github.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/21-updating-agent-instructions-hackernews.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/27-updating-agent-instructions-filesystem.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/31-enhancing-memory-configuration.md +3 -3
- package/.docs/raw/course/03-agent-memory/04-creating-basic-memory-agent.md +1 -2
- package/.docs/raw/course/03-agent-memory/07-understanding-memory-threads.md +35 -0
- package/.docs/raw/course/03-agent-memory/08-configuring-conversation-history.md +1 -2
- package/.docs/raw/course/03-agent-memory/13-vector-store-configuration.md +1 -1
- package/.docs/raw/course/03-agent-memory/16-configuring-semantic-recall.md +4 -5
- package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +1 -1
- package/.docs/raw/course/03-agent-memory/21-configuring-working-memory.md +3 -4
- package/.docs/raw/course/03-agent-memory/22-custom-working-memory-templates.md +3 -4
- package/.docs/raw/course/03-agent-memory/25-combining-memory-features.md +3 -4
- package/.docs/raw/course/03-agent-memory/27-creating-learning-assistant.md +3 -4
- package/.docs/raw/course/04-workflows/11-creating-an-ai-agent.md +2 -3
- package/.docs/raw/deployment/cloud-providers.mdx +22 -0
- package/.docs/raw/deployment/mastra-server.mdx +140 -0
- package/.docs/raw/deployment/monorepo.mdx +106 -42
- package/.docs/raw/deployment/overview.mdx +35 -48
- package/.docs/raw/deployment/web-framework.mdx +17 -19
- package/.docs/raw/deployment/workflow-runners.mdx +16 -0
- package/.docs/raw/evals/built-in-scorers.mdx +2 -0
- package/.docs/raw/evals/custom-scorers.mdx +60 -12
- package/.docs/raw/evals/overview.mdx +6 -6
- package/.docs/raw/evals/running-in-ci.mdx +4 -2
- package/.docs/raw/getting-started/manual-install.mdx +20 -20
- package/.docs/raw/getting-started/mcp-docs-server.mdx +59 -2
- package/.docs/raw/getting-started/project-structure.mdx +2 -2
- package/.docs/raw/getting-started/start.mdx +17 -1
- package/.docs/raw/getting-started/studio.mdx +6 -35
- package/.docs/raw/guides/agent-frameworks/ai-sdk.mdx +23 -33
- package/.docs/raw/guides/build-your-ui/ai-sdk-ui.mdx +1034 -80
- package/.docs/raw/guides/build-your-ui/assistant-ui.mdx +8 -8
- package/.docs/raw/guides/build-your-ui/copilotkit.mdx +32 -11
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/amazon-ec2.mdx +9 -9
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/aws-lambda.mdx +13 -16
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/azure-app-services.mdx +5 -7
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/cloudflare-deployer.mdx +8 -5
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/digital-ocean.mdx +18 -23
- package/.docs/raw/guides/deployment/index.mdx +32 -0
- package/.docs/raw/guides/deployment/inngest.mdx +673 -0
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/netlify-deployer.mdx +7 -3
- package/.docs/raw/{deployment/cloud-providers → guides/deployment}/vercel-deployer.mdx +8 -5
- package/.docs/raw/guides/getting-started/astro.mdx +292 -451
- package/.docs/raw/guides/getting-started/express.mdx +72 -153
- package/.docs/raw/guides/getting-started/hono.mdx +227 -0
- package/.docs/raw/guides/getting-started/next-js.mdx +173 -61
- package/.docs/raw/guides/getting-started/nuxt.mdx +505 -0
- package/.docs/raw/guides/getting-started/quickstart.mdx +5 -5
- package/.docs/raw/guides/getting-started/sveltekit.mdx +238 -409
- package/.docs/raw/guides/getting-started/vite-react.mdx +317 -147
- package/.docs/raw/guides/guide/ai-recruiter.mdx +10 -10
- package/.docs/raw/guides/guide/chef-michel.mdx +9 -11
- package/.docs/raw/guides/guide/notes-mcp-server.mdx +15 -15
- package/.docs/raw/guides/guide/research-assistant.mdx +20 -20
- package/.docs/raw/guides/guide/stock-agent.mdx +5 -5
- package/.docs/raw/guides/guide/web-search.mdx +38 -38
- package/.docs/raw/guides/guide/whatsapp-chat-bot.mdx +7 -7
- package/.docs/raw/guides/index.mdx +0 -1
- package/.docs/raw/guides/migrations/ai-sdk-v4-to-v5.mdx +2 -2
- package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +105 -4
- package/.docs/raw/guides/migrations/upgrade-to-v1/cli.mdx +15 -1
- package/.docs/raw/guides/migrations/upgrade-to-v1/client.mdx +170 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/deployment.mdx +42 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +0 -35
- package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx +40 -3
- package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +17 -2
- package/.docs/raw/guides/migrations/upgrade-to-v1/processors.mdx +11 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/rag.mdx +47 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx +271 -25
- package/.docs/raw/guides/migrations/upgrade-to-v1/tracing.mdx +72 -17
- package/.docs/raw/guides/migrations/upgrade-to-v1/vectors.mdx +46 -1
- package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +50 -7
- package/.docs/raw/guides/migrations/vnext-to-standard-apis.mdx +21 -23
- package/.docs/raw/index.mdx +2 -2
- package/.docs/raw/mastra-cloud/deployment.mdx +86 -0
- package/.docs/raw/mastra-cloud/observability.mdx +43 -0
- package/.docs/raw/mastra-cloud/overview.mdx +31 -0
- package/.docs/raw/mastra-cloud/setup.mdx +64 -0
- package/.docs/raw/mastra-cloud/studio.mdx +35 -0
- package/.docs/raw/mcp/overview.mdx +60 -25
- package/.docs/raw/mcp/publishing-mcp-server.mdx +7 -4
- package/.docs/raw/memory/memory-processors.mdx +17 -12
- package/.docs/raw/memory/message-history.mdx +72 -0
- package/.docs/raw/memory/overview.mdx +38 -76
- package/.docs/raw/memory/semantic-recall.mdx +65 -52
- package/.docs/raw/memory/storage.mdx +248 -0
- package/.docs/raw/memory/working-memory.mdx +24 -13
- package/.docs/raw/observability/logging.mdx +16 -15
- package/.docs/raw/observability/overview.mdx +27 -7
- package/.docs/raw/observability/tracing/bridges/otel.mdx +7 -4
- package/.docs/raw/observability/tracing/exporters/arize.mdx +61 -24
- package/.docs/raw/observability/tracing/exporters/braintrust.mdx +32 -22
- package/.docs/raw/observability/tracing/exporters/cloud.mdx +24 -5
- package/.docs/raw/observability/tracing/exporters/datadog.mdx +175 -0
- package/.docs/raw/observability/tracing/exporters/default.mdx +28 -7
- package/.docs/raw/observability/tracing/exporters/laminar.mdx +89 -0
- package/.docs/raw/observability/tracing/exporters/langfuse.mdx +31 -22
- package/.docs/raw/observability/tracing/exporters/langsmith.mdx +33 -3
- package/.docs/raw/observability/tracing/exporters/otel.mdx +194 -22
- package/.docs/raw/observability/tracing/exporters/posthog.mdx +32 -22
- package/.docs/raw/observability/tracing/exporters/sentry.mdx +198 -0
- package/.docs/raw/observability/tracing/overview.mdx +388 -108
- package/.docs/raw/observability/tracing/processors/sensitive-data-filter.mdx +27 -7
- package/.docs/raw/rag/chunking-and-embedding.mdx +22 -33
- package/.docs/raw/rag/graph-rag.mdx +223 -0
- package/.docs/raw/rag/overview.mdx +6 -3
- package/.docs/raw/rag/retrieval.mdx +53 -57
- package/.docs/raw/rag/vector-databases.mdx +55 -31
- package/.docs/raw/reference/agents/agent.mdx +17 -14
- package/.docs/raw/reference/agents/generate.mdx +172 -44
- package/.docs/raw/reference/agents/generateLegacy.mdx +5 -3
- package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +5 -3
- package/.docs/raw/reference/agents/getDefaultOptions.mdx +5 -3
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +5 -3
- package/.docs/raw/reference/agents/getDescription.mdx +3 -1
- package/.docs/raw/reference/agents/getInstructions.mdx +5 -3
- package/.docs/raw/reference/agents/getLLM.mdx +5 -3
- package/.docs/raw/reference/agents/getMemory.mdx +5 -3
- package/.docs/raw/reference/agents/getModel.mdx +5 -3
- package/.docs/raw/reference/agents/getTools.mdx +4 -2
- package/.docs/raw/reference/agents/getVoice.mdx +4 -2
- package/.docs/raw/reference/agents/listAgents.mdx +4 -2
- package/.docs/raw/reference/agents/listScorers.mdx +5 -3
- package/.docs/raw/reference/agents/listTools.mdx +4 -2
- package/.docs/raw/reference/agents/listWorkflows.mdx +4 -2
- package/.docs/raw/reference/agents/network.mdx +113 -1
- package/.docs/raw/reference/ai-sdk/chat-route.mdx +6 -3
- package/.docs/raw/reference/ai-sdk/handle-chat-stream.mdx +4 -2
- package/.docs/raw/reference/ai-sdk/handle-network-stream.mdx +4 -2
- package/.docs/raw/reference/ai-sdk/handle-workflow-stream.mdx +5 -3
- package/.docs/raw/reference/ai-sdk/network-route.mdx +6 -3
- package/.docs/raw/reference/ai-sdk/to-ai-sdk-stream.mdx +10 -6
- package/.docs/raw/reference/ai-sdk/to-ai-sdk-v4-messages.mdx +130 -0
- package/.docs/raw/reference/ai-sdk/to-ai-sdk-v5-messages.mdx +110 -0
- package/.docs/raw/reference/ai-sdk/with-mastra.mdx +122 -0
- package/.docs/raw/reference/ai-sdk/workflow-route.mdx +7 -4
- package/.docs/raw/reference/auth/auth0.mdx +5 -3
- package/.docs/raw/reference/auth/clerk.mdx +5 -3
- package/.docs/raw/reference/auth/firebase.mdx +6 -5
- package/.docs/raw/reference/auth/jwt.mdx +5 -3
- package/.docs/raw/reference/auth/supabase.mdx +5 -3
- package/.docs/raw/reference/auth/workos.mdx +5 -3
- package/.docs/raw/reference/cli/create-mastra.mdx +12 -10
- package/.docs/raw/reference/cli/mastra.mdx +63 -15
- package/.docs/raw/reference/client-js/agents.mdx +77 -35
- package/.docs/raw/reference/client-js/error-handling.mdx +3 -3
- package/.docs/raw/reference/client-js/logs.mdx +2 -0
- package/.docs/raw/reference/client-js/mastra-client.mdx +4 -2
- package/.docs/raw/reference/client-js/memory.mdx +43 -1
- package/.docs/raw/reference/client-js/observability.mdx +2 -0
- package/.docs/raw/reference/client-js/telemetry.mdx +2 -0
- package/.docs/raw/reference/client-js/tools.mdx +2 -0
- package/.docs/raw/reference/client-js/vectors.mdx +2 -0
- package/.docs/raw/reference/client-js/workflows.mdx +47 -3
- package/.docs/raw/reference/configuration.mdx +761 -0
- package/.docs/raw/reference/core/addGateway.mdx +2 -0
- package/.docs/raw/reference/core/getAgent.mdx +3 -1
- package/.docs/raw/reference/core/getAgentById.mdx +3 -1
- package/.docs/raw/reference/core/getDeployer.mdx +3 -1
- package/.docs/raw/reference/core/getGateway.mdx +2 -0
- package/.docs/raw/reference/core/getGatewayById.mdx +2 -0
- package/.docs/raw/reference/core/getLogger.mdx +3 -1
- package/.docs/raw/reference/core/getMCPServer.mdx +3 -1
- package/.docs/raw/reference/core/getMCPServerById.mdx +3 -1
- package/.docs/raw/reference/core/getMemory.mdx +7 -3
- package/.docs/raw/reference/core/getScorer.mdx +2 -0
- package/.docs/raw/reference/core/getScorerById.mdx +2 -0
- package/.docs/raw/reference/core/getServer.mdx +6 -4
- package/.docs/raw/reference/core/getStorage.mdx +5 -3
- package/.docs/raw/reference/core/getStoredAgentById.mdx +6 -4
- package/.docs/raw/reference/core/getTelemetry.mdx +3 -1
- package/.docs/raw/reference/core/getVector.mdx +3 -1
- package/.docs/raw/reference/core/getWorkflow.mdx +3 -1
- package/.docs/raw/reference/core/listAgents.mdx +3 -1
- package/.docs/raw/reference/core/listGateways.mdx +2 -0
- package/.docs/raw/reference/core/listLogs.mdx +3 -1
- package/.docs/raw/reference/core/listLogsByRunId.mdx +3 -1
- package/.docs/raw/reference/core/listMCPServers.mdx +3 -1
- package/.docs/raw/reference/core/listMemory.mdx +8 -4
- package/.docs/raw/reference/core/listScorers.mdx +2 -0
- package/.docs/raw/reference/core/listStoredAgents.mdx +7 -5
- package/.docs/raw/reference/core/listVectors.mdx +3 -1
- package/.docs/raw/reference/core/listWorkflows.mdx +3 -1
- package/.docs/raw/reference/core/mastra-class.mdx +27 -20
- package/.docs/raw/reference/core/mastra-model-gateway.mdx +2 -0
- package/.docs/raw/reference/core/setLogger.mdx +3 -1
- package/.docs/raw/reference/core/setStorage.mdx +6 -4
- package/.docs/raw/reference/deployer/cloudflare.mdx +22 -53
- package/.docs/raw/reference/deployer/deployer.mdx +2 -1
- package/.docs/raw/reference/deployer/netlify.mdx +4 -1
- package/.docs/raw/reference/deployer/vercel.mdx +5 -4
- package/.docs/raw/reference/evals/answer-relevancy.mdx +4 -1
- package/.docs/raw/reference/evals/answer-similarity.mdx +4 -1
- package/.docs/raw/reference/evals/bias.mdx +4 -1
- package/.docs/raw/reference/evals/completeness.mdx +4 -1
- package/.docs/raw/reference/evals/content-similarity.mdx +4 -1
- package/.docs/raw/reference/evals/context-precision.mdx +4 -1
- package/.docs/raw/reference/evals/context-relevance.mdx +2 -0
- package/.docs/raw/reference/evals/create-scorer.mdx +11 -3
- package/.docs/raw/reference/evals/faithfulness.mdx +4 -1
- package/.docs/raw/reference/evals/hallucination.mdx +4 -1
- package/.docs/raw/reference/evals/keyword-coverage.mdx +4 -1
- package/.docs/raw/reference/evals/mastra-scorer.mdx +2 -0
- package/.docs/raw/reference/evals/noise-sensitivity.mdx +2 -0
- package/.docs/raw/reference/evals/prompt-alignment.mdx +9 -7
- package/.docs/raw/reference/evals/run-evals.mdx +3 -1
- package/.docs/raw/reference/evals/scorer-utils.mdx +3 -0
- package/.docs/raw/reference/evals/textual-difference.mdx +4 -1
- package/.docs/raw/reference/evals/tone-consistency.mdx +4 -1
- package/.docs/raw/reference/evals/tool-call-accuracy.mdx +25 -23
- package/.docs/raw/reference/evals/toxicity.mdx +4 -1
- package/.docs/raw/reference/index.mdx +2 -1
- package/.docs/raw/reference/logging/pino-logger.mdx +10 -8
- package/.docs/raw/reference/memory/clone-utilities.mdx +345 -0
- package/.docs/raw/reference/memory/cloneThread.mdx +237 -0
- package/.docs/raw/reference/memory/createThread.mdx +6 -4
- package/.docs/raw/reference/memory/deleteMessages.mdx +4 -2
- package/.docs/raw/reference/memory/getThreadById.mdx +3 -1
- package/.docs/raw/reference/memory/listThreads.mdx +187 -0
- package/.docs/raw/reference/memory/memory-class.mdx +27 -20
- package/.docs/raw/reference/memory/recall.mdx +6 -4
- package/.docs/raw/reference/observability/tracing/bridges/otel.mdx +6 -2
- package/.docs/raw/reference/observability/tracing/configuration.mdx +51 -0
- package/.docs/raw/reference/observability/tracing/exporters/arize.mdx +25 -6
- package/.docs/raw/reference/observability/tracing/exporters/braintrust.mdx +23 -2
- package/.docs/raw/reference/observability/tracing/exporters/cloud-exporter.mdx +10 -0
- package/.docs/raw/reference/observability/tracing/exporters/console-exporter.mdx +3 -0
- package/.docs/raw/reference/observability/tracing/exporters/datadog.mdx +172 -0
- package/.docs/raw/reference/observability/tracing/exporters/default-exporter.mdx +10 -0
- package/.docs/raw/reference/observability/tracing/exporters/laminar.mdx +139 -0
- package/.docs/raw/reference/observability/tracing/exporters/langfuse.mdx +26 -4
- package/.docs/raw/reference/observability/tracing/exporters/langsmith.mdx +10 -0
- package/.docs/raw/reference/observability/tracing/exporters/otel.mdx +51 -34
- package/.docs/raw/reference/observability/tracing/exporters/posthog.mdx +25 -4
- package/.docs/raw/reference/observability/tracing/exporters/sentry.mdx +224 -0
- package/.docs/raw/reference/observability/tracing/instances.mdx +2 -0
- package/.docs/raw/reference/observability/tracing/interfaces.mdx +20 -0
- package/.docs/raw/reference/observability/tracing/processors/sensitive-data-filter.mdx +2 -0
- package/.docs/raw/reference/observability/tracing/spans.mdx +2 -0
- package/.docs/raw/reference/processors/batch-parts-processor.mdx +4 -2
- package/.docs/raw/reference/processors/language-detector.mdx +6 -3
- package/.docs/raw/reference/processors/message-history-processor.mdx +5 -2
- package/.docs/raw/reference/processors/moderation-processor.mdx +6 -4
- package/.docs/raw/reference/processors/pii-detector.mdx +6 -4
- package/.docs/raw/reference/processors/processor-interface.mdx +326 -23
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +5 -3
- package/.docs/raw/reference/processors/semantic-recall-processor.mdx +7 -2
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +5 -3
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +62 -19
- package/.docs/raw/reference/processors/tool-call-filter.mdx +5 -3
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +6 -3
- package/.docs/raw/reference/processors/working-memory-processor.mdx +6 -3
- package/.docs/raw/reference/rag/chunk.mdx +7 -6
- package/.docs/raw/reference/rag/database-config.mdx +8 -6
- package/.docs/raw/reference/rag/document.mdx +2 -0
- package/.docs/raw/reference/rag/embeddings.mdx +2 -0
- package/.docs/raw/reference/rag/extract-params.mdx +57 -3
- package/.docs/raw/reference/rag/graph-rag.mdx +2 -0
- package/.docs/raw/reference/rag/metadata-filters.mdx +27 -7
- package/.docs/raw/reference/rag/rerank.mdx +2 -0
- package/.docs/raw/reference/rag/rerankWithScorer.mdx +2 -0
- package/.docs/raw/reference/server/create-route.mdx +34 -18
- package/.docs/raw/reference/server/express-adapter.mdx +27 -51
- package/.docs/raw/reference/server/fastify-adapter.mdx +130 -0
- package/.docs/raw/reference/server/hono-adapter.mdx +27 -51
- package/.docs/raw/reference/server/koa-adapter.mdx +129 -0
- package/.docs/raw/reference/server/mastra-server.mdx +52 -34
- package/.docs/raw/reference/server/routes.mdx +73 -10
- package/.docs/raw/reference/storage/cloudflare-d1.mdx +10 -5
- package/.docs/raw/reference/storage/cloudflare.mdx +12 -2
- package/.docs/raw/reference/storage/composite.mdx +245 -0
- package/.docs/raw/reference/storage/convex.mdx +8 -6
- package/.docs/raw/reference/storage/dynamodb.mdx +134 -8
- package/.docs/raw/reference/storage/lance.mdx +9 -5
- package/.docs/raw/reference/storage/libsql.mdx +76 -54
- package/.docs/raw/reference/storage/mongodb.mdx +115 -16
- package/.docs/raw/reference/storage/mssql.mdx +11 -6
- package/.docs/raw/{server-db/storage.mdx → reference/storage/overview.mdx} +15 -111
- package/.docs/raw/reference/storage/postgresql.mdx +228 -83
- package/.docs/raw/reference/storage/upstash.mdx +78 -2
- package/.docs/raw/reference/streaming/ChunkType.mdx +31 -3
- package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +67 -6
- package/.docs/raw/reference/streaming/agents/stream.mdx +48 -51
- package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +5 -3
- package/.docs/raw/reference/streaming/workflows/observeStream.mdx +3 -1
- package/.docs/raw/reference/streaming/workflows/resumeStream.mdx +3 -1
- package/.docs/raw/reference/streaming/workflows/stream.mdx +37 -22
- package/.docs/raw/reference/streaming/workflows/timeTravelStream.mdx +6 -4
- package/.docs/raw/reference/templates/overview.mdx +3 -2
- package/.docs/raw/reference/tools/client.mdx +3 -0
- package/.docs/raw/reference/tools/create-tool.mdx +127 -5
- package/.docs/raw/reference/tools/document-chunker-tool.mdx +2 -0
- package/.docs/raw/reference/tools/graph-rag-tool.mdx +40 -3
- package/.docs/raw/reference/tools/mcp-client.mdx +110 -1
- package/.docs/raw/reference/tools/mcp-server.mdx +278 -24
- package/.docs/raw/reference/tools/vector-query-tool.mdx +68 -4
- package/.docs/raw/reference/vectors/astra.mdx +5 -3
- package/.docs/raw/reference/vectors/chroma.mdx +5 -3
- package/.docs/raw/reference/vectors/convex.mdx +14 -12
- package/.docs/raw/reference/vectors/couchbase.mdx +7 -5
- package/.docs/raw/reference/vectors/duckdb.mdx +12 -10
- package/.docs/raw/reference/vectors/elasticsearch.mdx +12 -4
- package/.docs/raw/reference/vectors/lance.mdx +6 -4
- package/.docs/raw/reference/vectors/libsql.mdx +66 -13
- package/.docs/raw/reference/vectors/mongodb.mdx +90 -10
- package/.docs/raw/reference/vectors/opensearch.mdx +30 -3
- package/.docs/raw/reference/vectors/pg.mdx +58 -6
- package/.docs/raw/reference/vectors/pinecone.mdx +23 -8
- package/.docs/raw/reference/vectors/qdrant.mdx +148 -4
- package/.docs/raw/reference/vectors/s3vectors.mdx +8 -6
- package/.docs/raw/reference/vectors/turbopuffer.mdx +6 -4
- package/.docs/raw/reference/vectors/upstash.mdx +60 -6
- package/.docs/raw/reference/vectors/vectorize.mdx +5 -3
- package/.docs/raw/reference/voice/azure.mdx +2 -0
- package/.docs/raw/reference/voice/cloudflare.mdx +2 -0
- package/.docs/raw/reference/voice/composite-voice.mdx +4 -0
- package/.docs/raw/reference/voice/deepgram.mdx +2 -0
- package/.docs/raw/reference/voice/elevenlabs.mdx +2 -0
- package/.docs/raw/reference/voice/google-gemini-live.mdx +3 -0
- package/.docs/raw/reference/voice/google.mdx +2 -0
- package/.docs/raw/reference/voice/mastra-voice.mdx +2 -0
- package/.docs/raw/reference/voice/murf.mdx +2 -0
- package/.docs/raw/reference/voice/openai-realtime.mdx +3 -0
- package/.docs/raw/reference/voice/openai.mdx +2 -0
- package/.docs/raw/reference/voice/playai.mdx +2 -0
- package/.docs/raw/reference/voice/sarvam.mdx +2 -0
- package/.docs/raw/reference/voice/speechify.mdx +2 -0
- package/.docs/raw/reference/voice/voice.addInstructions.mdx +3 -0
- package/.docs/raw/reference/voice/voice.addTools.mdx +3 -0
- package/.docs/raw/reference/voice/voice.answer.mdx +4 -0
- package/.docs/raw/reference/voice/voice.close.mdx +3 -0
- package/.docs/raw/reference/voice/voice.connect.mdx +5 -1
- package/.docs/raw/reference/voice/voice.events.mdx +2 -0
- package/.docs/raw/reference/voice/voice.getSpeakers.mdx +3 -0
- package/.docs/raw/reference/voice/voice.listen.mdx +6 -0
- package/.docs/raw/reference/voice/voice.off.mdx +2 -0
- package/.docs/raw/reference/voice/voice.on.mdx +5 -1
- package/.docs/raw/reference/voice/voice.send.mdx +4 -0
- package/.docs/raw/reference/voice/voice.speak.mdx +6 -0
- package/.docs/raw/reference/voice/voice.updateConfig.mdx +2 -0
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +55 -5
- package/.docs/raw/reference/workflows/run-methods/restart.mdx +3 -3
- package/.docs/raw/reference/workflows/run-methods/resume.mdx +6 -4
- package/.docs/raw/reference/workflows/run-methods/start.mdx +7 -5
- package/.docs/raw/reference/workflows/run-methods/startAsync.mdx +145 -0
- package/.docs/raw/reference/workflows/run-methods/timeTravel.mdx +10 -8
- package/.docs/raw/reference/workflows/run.mdx +11 -3
- package/.docs/raw/reference/workflows/step.mdx +56 -3
- package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +39 -2
- package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +71 -4
- package/.docs/raw/reference/workflows/workflow-methods/map.mdx +9 -7
- package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +4 -6
- package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +4 -6
- package/.docs/raw/reference/workflows/workflow-methods/then.mdx +3 -1
- package/.docs/raw/reference/workflows/workflow.mdx +193 -2
- package/.docs/raw/{auth → server/auth}/auth0.mdx +40 -21
- package/.docs/raw/{auth → server/auth}/clerk.mdx +37 -16
- package/.docs/raw/{auth → server/auth}/firebase.mdx +47 -25
- package/.docs/raw/{auth → server/auth}/index.mdx +8 -6
- package/.docs/raw/{auth → server/auth}/jwt.mdx +22 -10
- package/.docs/raw/{auth → server/auth}/supabase.mdx +45 -25
- package/.docs/raw/{auth → server/auth}/workos.mdx +39 -20
- package/.docs/raw/{server-db → server}/custom-adapters.mdx +40 -24
- package/.docs/raw/{server-db → server}/custom-api-routes.mdx +6 -6
- package/.docs/raw/{server-db → server}/mastra-client.mdx +35 -38
- package/.docs/raw/server/mastra-server.mdx +86 -0
- package/.docs/raw/{server-db → server}/middleware.mdx +11 -9
- package/.docs/raw/{server-db → server}/request-context.mdx +85 -43
- package/.docs/raw/{server-db → server}/server-adapters.mdx +154 -33
- package/.docs/raw/streaming/events.mdx +16 -7
- package/.docs/raw/streaming/overview.mdx +30 -17
- package/.docs/raw/streaming/tool-streaming.mdx +8 -6
- package/.docs/raw/streaming/workflow-streaming.mdx +8 -8
- package/.docs/raw/tools-mcp/advanced-usage.mdx +4 -2
- package/.docs/raw/tools-mcp/mcp-overview.mdx +46 -12
- package/.docs/raw/tools-mcp/overview.mdx +14 -13
- package/.docs/raw/voice/overview.mdx +17 -2
- package/.docs/raw/voice/speech-to-speech.mdx +5 -0
- package/.docs/raw/voice/speech-to-text.mdx +4 -0
- package/.docs/raw/voice/text-to-speech.mdx +3 -0
- package/.docs/raw/workflows/agents-and-tools.mdx +70 -21
- package/.docs/raw/workflows/control-flow.mdx +369 -34
- package/.docs/raw/workflows/error-handling.mdx +192 -18
- package/.docs/raw/workflows/human-in-the-loop.mdx +8 -7
- package/.docs/raw/workflows/input-data-mapping.mdx +9 -7
- package/.docs/raw/workflows/overview.mdx +80 -34
- package/.docs/raw/workflows/snapshots.mdx +19 -45
- package/.docs/raw/workflows/suspend-and-resume.mdx +14 -14
- package/.docs/raw/workflows/time-travel.mdx +25 -21
- package/.docs/raw/workflows/workflow-state.mdx +7 -8
- package/CHANGELOG.md +260 -0
- package/README.md +36 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/logger.d.ts +3 -0
- package/dist/logger.d.ts.map +1 -1
- package/dist/stdio.js +746 -49
- package/dist/tools/course.d.ts.map +1 -1
- package/dist/tools/embedded-docs.d.ts +276 -0
- package/dist/tools/embedded-docs.d.ts.map +1 -0
- package/package.json +9 -8
- package/.docs/organized/changelogs/%40internal%2Fai-sdk-v4.md +0 -1
- package/.docs/raw/deployment/building-mastra.mdx +0 -73
- package/.docs/raw/deployment/cloud-providers/index.mdx +0 -55
- package/.docs/raw/deployment/mastra-cloud/dashboard.mdx +0 -100
- package/.docs/raw/deployment/mastra-cloud/observability.mdx +0 -53
- package/.docs/raw/deployment/mastra-cloud/overview.mdx +0 -65
- package/.docs/raw/deployment/mastra-cloud/setting-up.mdx +0 -105
- package/.docs/raw/memory/conversation-history.mdx +0 -24
- package/.docs/raw/memory/storage/memory-with-libsql.mdx +0 -140
- package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -150
- package/.docs/raw/memory/storage/memory-with-pg.mdx +0 -138
- package/.docs/raw/memory/storage/memory-with-upstash.mdx +0 -146
- package/.docs/raw/memory/threads-and-resources.mdx +0 -95
- package/.docs/raw/reference/core/setTelemetry.mdx +0 -36
- package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +0 -110
- package/.docs/raw/reference/memory/query.mdx +0 -189
- package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +0 -70
- package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +0 -66
- package/.docs/raw/server-db/mastra-server.mdx +0 -97
- package/.docs/raw/workflows/inngest-workflow.mdx +0 -363
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: PosthogExporter | Observability"
|
|
3
3
|
description: PostHog exporter for Tracing
|
|
4
|
+
packages:
|
|
5
|
+
- "@mastra/posthog"
|
|
4
6
|
---
|
|
5
7
|
|
|
6
8
|
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
@@ -19,7 +21,7 @@ new PosthogExporter(config: PosthogExporterConfig)
|
|
|
19
21
|
|
|
20
22
|
```typescript
|
|
21
23
|
interface PosthogExporterConfig extends BaseExporterConfig {
|
|
22
|
-
apiKey
|
|
24
|
+
apiKey?: string;
|
|
23
25
|
host?: string;
|
|
24
26
|
flushAt?: number;
|
|
25
27
|
flushInterval?: number;
|
|
@@ -38,13 +40,13 @@ Extends `BaseExporterConfig`, which includes:
|
|
|
38
40
|
{
|
|
39
41
|
name: "apiKey",
|
|
40
42
|
type: "string",
|
|
41
|
-
description: "PostHog project API key",
|
|
42
|
-
required:
|
|
43
|
+
description: "PostHog project API key. Falls back to POSTHOG_API_KEY env var.",
|
|
44
|
+
required: false,
|
|
43
45
|
},
|
|
44
46
|
{
|
|
45
47
|
name: "host",
|
|
46
48
|
type: "string",
|
|
47
|
-
description: "PostHog host URL (default: 'https://us.i.posthog.com')",
|
|
49
|
+
description: "PostHog host URL. Falls back to POSTHOG_HOST env var. (default: 'https://us.i.posthog.com')",
|
|
48
50
|
required: false,
|
|
49
51
|
},
|
|
50
52
|
{
|
|
@@ -96,6 +98,14 @@ async exportTracingEvent(event: TracingEvent): Promise<void>
|
|
|
96
98
|
|
|
97
99
|
Exports a tracing event to PostHog.
|
|
98
100
|
|
|
101
|
+
### flush
|
|
102
|
+
|
|
103
|
+
```typescript
|
|
104
|
+
async flush(): Promise<void>
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
Force flushes any buffered events to PostHog without shutting down the exporter. Useful in serverless environments where you need to ensure spans are exported before the runtime terminates.
|
|
108
|
+
|
|
99
109
|
### shutdown
|
|
100
110
|
|
|
101
111
|
```typescript
|
|
@@ -106,6 +116,17 @@ Flushes pending batched events and shuts down the PostHog client.
|
|
|
106
116
|
|
|
107
117
|
## Usage
|
|
108
118
|
|
|
119
|
+
### Zero-Config (using environment variables)
|
|
120
|
+
|
|
121
|
+
```typescript
|
|
122
|
+
import { PosthogExporter } from "@mastra/posthog";
|
|
123
|
+
|
|
124
|
+
// Reads from POSTHOG_API_KEY, POSTHOG_HOST
|
|
125
|
+
const exporter = new PosthogExporter();
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
### Explicit Configuration
|
|
129
|
+
|
|
109
130
|
```typescript
|
|
110
131
|
import { PosthogExporter } from "@mastra/posthog";
|
|
111
132
|
|
|
@@ -0,0 +1,224 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Reference: SentryExporter | Observability"
|
|
3
|
+
description: Sentry AI monitoring exporter for Tracing
|
|
4
|
+
packages:
|
|
5
|
+
- "@mastra/sentry"
|
|
6
|
+
- "@mastra/observability"
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
10
|
+
|
|
11
|
+
# SentryExporter
|
|
12
|
+
|
|
13
|
+
Sends Tracing data to Sentry for AI tracing and monitoring using OpenTelemetry semantic conventions.
|
|
14
|
+
|
|
15
|
+
## Constructor
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
new SentryExporter(config: SentryExporterConfig)
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## SentryExporterConfig
|
|
22
|
+
|
|
23
|
+
```typescript
|
|
24
|
+
interface SentryExporterConfig extends BaseExporterConfig {
|
|
25
|
+
dsn?: string;
|
|
26
|
+
environment?: string;
|
|
27
|
+
tracesSampleRate?: number;
|
|
28
|
+
release?: string;
|
|
29
|
+
options?: Partial<Sentry.NodeOptions>;
|
|
30
|
+
}
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
Extends `BaseExporterConfig`, which includes:
|
|
34
|
+
- `logger?: IMastraLogger` - Logger instance
|
|
35
|
+
- `logLevel?: LogLevel | 'debug' | 'info' | 'warn' | 'error'` - Log level (default: INFO)
|
|
36
|
+
|
|
37
|
+
<PropertiesTable
|
|
38
|
+
props={[
|
|
39
|
+
{
|
|
40
|
+
name: "dsn",
|
|
41
|
+
type: "string",
|
|
42
|
+
description: "Data Source Name - tells the SDK where to send events. Either this parameter or the SENTRY_DSN env var must be set. Falls back to SENTRY_DSN env var.",
|
|
43
|
+
required: false,
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
name: "environment",
|
|
47
|
+
type: "string",
|
|
48
|
+
description: "Deployment environment (enables filtering issues and alerts by environment). Falls back to SENTRY_ENVIRONMENT env var. Default: 'production'.",
|
|
49
|
+
required: false,
|
|
50
|
+
},
|
|
51
|
+
{
|
|
52
|
+
name: "tracesSampleRate",
|
|
53
|
+
type: "number",
|
|
54
|
+
description: "Percentage of transactions sent to Sentry (0.0 = 0%, 1.0 = 100%). Default: 1.0.",
|
|
55
|
+
required: false,
|
|
56
|
+
},
|
|
57
|
+
{
|
|
58
|
+
name: "release",
|
|
59
|
+
type: "string",
|
|
60
|
+
description: "Version of your code deployed (helps identify regressions and track deployments). Falls back to SENTRY_RELEASE env var.",
|
|
61
|
+
required: false,
|
|
62
|
+
},
|
|
63
|
+
{
|
|
64
|
+
name: "options",
|
|
65
|
+
type: "Partial<Sentry.NodeOptions>",
|
|
66
|
+
description: "Additional Sentry SDK options (integrations, beforeSend, etc.). See Sentry SDK documentation for available options.",
|
|
67
|
+
required: false,
|
|
68
|
+
},
|
|
69
|
+
]}
|
|
70
|
+
/>
|
|
71
|
+
|
|
72
|
+
## Methods
|
|
73
|
+
|
|
74
|
+
### exportTracingEvent
|
|
75
|
+
|
|
76
|
+
```typescript
|
|
77
|
+
async exportTracingEvent(event: TracingEvent): Promise<void>
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Exports a tracing event to Sentry. Handles SPAN_STARTED, SPAN_UPDATED, and SPAN_ENDED events.
|
|
81
|
+
|
|
82
|
+
### flush
|
|
83
|
+
|
|
84
|
+
```typescript
|
|
85
|
+
async flush(): Promise<void>
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
Force flushes any pending spans to Sentry without shutting down the exporter. Waits up to 2 seconds for pending data to be sent. Useful in serverless environments where you need to ensure spans are exported before the runtime terminates.
|
|
89
|
+
|
|
90
|
+
### shutdown
|
|
91
|
+
|
|
92
|
+
```typescript
|
|
93
|
+
async shutdown(): Promise<void>
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
Ends all active spans, clears internal state, and closes the Sentry connection. Waits up to 2 seconds for pending data to be sent.
|
|
97
|
+
|
|
98
|
+
## Usage
|
|
99
|
+
|
|
100
|
+
### Zero-Config (using environment variables)
|
|
101
|
+
|
|
102
|
+
```typescript
|
|
103
|
+
import { SentryExporter } from "@mastra/sentry";
|
|
104
|
+
|
|
105
|
+
// Reads from SENTRY_DSN, SENTRY_ENVIRONMENT, SENTRY_RELEASE
|
|
106
|
+
const exporter = new SentryExporter();
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### Explicit Configuration
|
|
110
|
+
|
|
111
|
+
```typescript
|
|
112
|
+
import { SentryExporter } from "@mastra/sentry";
|
|
113
|
+
|
|
114
|
+
const exporter = new SentryExporter({
|
|
115
|
+
dsn: process.env.SENTRY_DSN,
|
|
116
|
+
environment: "production",
|
|
117
|
+
tracesSampleRate: 1.0,
|
|
118
|
+
release: "1.0.0",
|
|
119
|
+
});
|
|
120
|
+
```
|
|
121
|
+
|
|
122
|
+
### With Sampling
|
|
123
|
+
|
|
124
|
+
```typescript
|
|
125
|
+
const exporter = new SentryExporter({
|
|
126
|
+
dsn: process.env.SENTRY_DSN,
|
|
127
|
+
environment: "production",
|
|
128
|
+
tracesSampleRate: 0.1, // Send 10% of transactions to Sentry (recommended for high-load backends)
|
|
129
|
+
});
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### With Custom Sentry Options
|
|
133
|
+
|
|
134
|
+
```typescript
|
|
135
|
+
const exporter = new SentryExporter({
|
|
136
|
+
dsn: process.env.SENTRY_DSN,
|
|
137
|
+
environment: "production",
|
|
138
|
+
options: {
|
|
139
|
+
integrations: [
|
|
140
|
+
// Custom Sentry integrations
|
|
141
|
+
],
|
|
142
|
+
beforeSend: (event) => {
|
|
143
|
+
// Custom event processing
|
|
144
|
+
return event;
|
|
145
|
+
},
|
|
146
|
+
},
|
|
147
|
+
});
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
## Span Mapping
|
|
151
|
+
|
|
152
|
+
Mastra span types are mapped to Sentry operations:
|
|
153
|
+
|
|
154
|
+
| Mastra SpanType | Sentry Operation |
|
|
155
|
+
| --------------------------- | ---------------------- |
|
|
156
|
+
| `AGENT_RUN` | `gen_ai.invoke_agent` |
|
|
157
|
+
| `MODEL_GENERATION` | `gen_ai.chat` |
|
|
158
|
+
| `MODEL_STEP` | _(skipped)_ |
|
|
159
|
+
| `MODEL_CHUNK` | _(skipped)_ |
|
|
160
|
+
| `TOOL_CALL` | `gen_ai.execute_tool` |
|
|
161
|
+
| `MCP_TOOL_CALL` | `gen_ai.execute_tool` |
|
|
162
|
+
| `WORKFLOW_RUN` | `workflow.run` |
|
|
163
|
+
| `WORKFLOW_STEP` | `workflow.step` |
|
|
164
|
+
| `WORKFLOW_CONDITIONAL` | `workflow.conditional` |
|
|
165
|
+
| `WORKFLOW_CONDITIONAL_EVAL` | `workflow.conditional` |
|
|
166
|
+
| `WORKFLOW_PARALLEL` | `workflow.parallel` |
|
|
167
|
+
| `WORKFLOW_LOOP` | `workflow.loop` |
|
|
168
|
+
| `WORKFLOW_SLEEP` | `workflow.sleep` |
|
|
169
|
+
| `WORKFLOW_WAIT_EVENT` | `workflow.wait` |
|
|
170
|
+
| `PROCESSOR_RUN` | `ai.processor` |
|
|
171
|
+
| `GENERIC` | `ai.span` |
|
|
172
|
+
|
|
173
|
+
MODEL_STEP and MODEL_CHUNK spans are skipped to simplify trace hierarchy. Their data is aggregated into MODEL_GENERATION spans.
|
|
174
|
+
|
|
175
|
+
## Environment Variables
|
|
176
|
+
|
|
177
|
+
The exporter reads configuration from these environment variables:
|
|
178
|
+
|
|
179
|
+
| Variable | Description |
|
|
180
|
+
| --------------------- | ---------------------------------------------------- |
|
|
181
|
+
| `SENTRY_DSN` | Data Source Name - tells the SDK where to send events |
|
|
182
|
+
| `SENTRY_ENVIRONMENT` | Deployment environment name |
|
|
183
|
+
| `SENTRY_RELEASE` | Version of your code deployed |
|
|
184
|
+
|
|
185
|
+
## OpenTelemetry Attributes
|
|
186
|
+
|
|
187
|
+
The exporter sets these standard OpenTelemetry attributes:
|
|
188
|
+
|
|
189
|
+
**Common attributes (all spans):**
|
|
190
|
+
- `sentry.origin`: `auto.ai.mastra` (identifies spans from Mastra)
|
|
191
|
+
- `ai.span.type`: Mastra span type
|
|
192
|
+
|
|
193
|
+
**MODEL_GENERATION spans:**
|
|
194
|
+
- `gen_ai.operation.name`: `chat`
|
|
195
|
+
- `gen_ai.system`: Model provider
|
|
196
|
+
- `gen_ai.request.model`: Model identifier
|
|
197
|
+
- `gen_ai.request.messages`: Input messages/prompts (JSON)
|
|
198
|
+
- `gen_ai.response.model`: Response model
|
|
199
|
+
- `gen_ai.response.text`: Output text
|
|
200
|
+
- `gen_ai.response.tool_calls`: Tool calls made during generation (JSON array)
|
|
201
|
+
- `gen_ai.usage.input_tokens`: Input token count
|
|
202
|
+
- `gen_ai.usage.output_tokens`: Output token count
|
|
203
|
+
- `gen_ai.usage.total_tokens`: Total tokens
|
|
204
|
+
- `gen_ai.request.stream`: Streaming flag
|
|
205
|
+
- `gen_ai.request.temperature`: Temperature parameter
|
|
206
|
+
- `gen_ai.completion_start_time`: First token time
|
|
207
|
+
|
|
208
|
+
**TOOL_CALL spans:**
|
|
209
|
+
- `gen_ai.operation.name`: `execute_tool`
|
|
210
|
+
- `gen_ai.tool.name`: Tool identifier
|
|
211
|
+
- `gen_ai.tool.type`: `function`
|
|
212
|
+
- `gen_ai.tool.call.id`: Tool call ID
|
|
213
|
+
- `gen_ai.tool.input`: Tool input
|
|
214
|
+
- `gen_ai.tool.output`: Tool output
|
|
215
|
+
- `tool.success`: Success flag
|
|
216
|
+
|
|
217
|
+
**AGENT_RUN spans:**
|
|
218
|
+
- `gen_ai.operation.name`: `invoke_agent`
|
|
219
|
+
- `gen_ai.agent.name`: Agent identifier
|
|
220
|
+
- `gen_ai.pipeline.name`: Agent name
|
|
221
|
+
- `gen_ai.agent.instructions`: Agent instructions
|
|
222
|
+
- `gen_ai.response.model`: Model from child generation
|
|
223
|
+
- `gen_ai.response.text`: Output from child generation
|
|
224
|
+
- `gen_ai.usage.*`: Token usage from child generation
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: Interfaces | Observability"
|
|
3
3
|
description: Tracing type definitions and interfaces
|
|
4
|
+
packages:
|
|
5
|
+
- "@mastra/core"
|
|
4
6
|
---
|
|
5
7
|
|
|
6
8
|
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
@@ -32,6 +34,9 @@ interface ObservabilityInstance {
|
|
|
32
34
|
options: StartSpanOptions<TType>,
|
|
33
35
|
): Span<TType>;
|
|
34
36
|
|
|
37
|
+
/** Force flush any buffered spans without shutting down */
|
|
38
|
+
flush(): Promise<void>;
|
|
39
|
+
|
|
35
40
|
/** Shutdown observability and clean up resources */
|
|
36
41
|
shutdown(): Promise<void>;
|
|
37
42
|
}
|
|
@@ -152,6 +157,9 @@ interface ObservabilityExporter {
|
|
|
152
157
|
metadata?: Record<string, any>;
|
|
153
158
|
}): Promise<void>;
|
|
154
159
|
|
|
160
|
+
/** Force flush any buffered spans without shutting down */
|
|
161
|
+
flush(): Promise<void>;
|
|
162
|
+
|
|
155
163
|
/** Shutdown exporter */
|
|
156
164
|
shutdown(): Promise<void>;
|
|
157
165
|
}
|
|
@@ -578,6 +586,18 @@ interface TracingOptions {
|
|
|
578
586
|
* Note: Tags are only applied to the root span of a trace.
|
|
579
587
|
*/
|
|
580
588
|
tags?: string[];
|
|
589
|
+
|
|
590
|
+
/**
|
|
591
|
+
* When true, input data will be hidden from all spans in this trace.
|
|
592
|
+
* Useful for protecting sensitive data from being logged.
|
|
593
|
+
*/
|
|
594
|
+
hideInput?: boolean;
|
|
595
|
+
|
|
596
|
+
/**
|
|
597
|
+
* When true, output data will be hidden from all spans in this trace.
|
|
598
|
+
* Useful for protecting sensitive data from being logged.
|
|
599
|
+
*/
|
|
600
|
+
hideOutput?: boolean;
|
|
581
601
|
}
|
|
582
602
|
```
|
|
583
603
|
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: Batch Parts Processor | Processors"
|
|
3
3
|
description: "Documentation for the BatchPartsProcessor in Mastra, which batches multiple stream parts together to reduce frequency of emissions."
|
|
4
|
+
packages:
|
|
5
|
+
- "@mastra/core"
|
|
4
6
|
---
|
|
5
7
|
|
|
6
8
|
# BatchPartsProcessor
|
|
@@ -9,7 +11,7 @@ The `BatchPartsProcessor` is an **output processor** that batches multiple strea
|
|
|
9
11
|
|
|
10
12
|
## Usage example
|
|
11
13
|
|
|
12
|
-
```typescript
|
|
14
|
+
```typescript
|
|
13
15
|
import { BatchPartsProcessor } from "@mastra/core/processors";
|
|
14
16
|
|
|
15
17
|
const processor = new BatchPartsProcessor({
|
|
@@ -93,7 +95,7 @@ const processor = new BatchPartsProcessor({
|
|
|
93
95
|
|
|
94
96
|
## Extended usage example
|
|
95
97
|
|
|
96
|
-
```typescript title="src/mastra/agents/batched-agent.ts"
|
|
98
|
+
```typescript title="src/mastra/agents/batched-agent.ts"
|
|
97
99
|
import { Agent } from "@mastra/core/agent";
|
|
98
100
|
import { BatchPartsProcessor } from "@mastra/core/processors";
|
|
99
101
|
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: Language Detector | Processors"
|
|
3
3
|
description: "Documentation for the LanguageDetector in Mastra, which detects language and can translate content in AI responses."
|
|
4
|
+
packages:
|
|
5
|
+
- "@mastra/core"
|
|
4
6
|
---
|
|
5
7
|
|
|
6
8
|
# LanguageDetector
|
|
@@ -9,7 +11,7 @@ The `LanguageDetector` is an **input processor** that identifies the language of
|
|
|
9
11
|
|
|
10
12
|
## Usage example
|
|
11
13
|
|
|
12
|
-
```typescript
|
|
14
|
+
```typescript
|
|
13
15
|
import { LanguageDetector } from "@mastra/core/processors";
|
|
14
16
|
|
|
15
17
|
const processor = new LanguageDetector({
|
|
@@ -127,7 +129,7 @@ const processor = new LanguageDetector({
|
|
|
127
129
|
},
|
|
128
130
|
{
|
|
129
131
|
name: "processInput",
|
|
130
|
-
type: "(args: { messages:
|
|
132
|
+
type: "(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never; tracingContext?: TracingContext }) => Promise<MastraDBMessage[]>",
|
|
131
133
|
description: "Processes input messages to detect language and optionally translate content before sending to LLM",
|
|
132
134
|
isOptional: false,
|
|
133
135
|
},
|
|
@@ -136,11 +138,12 @@ const processor = new LanguageDetector({
|
|
|
136
138
|
|
|
137
139
|
## Extended usage example
|
|
138
140
|
|
|
139
|
-
```typescript title="src/mastra/agents/multilingual-agent.ts"
|
|
141
|
+
```typescript title="src/mastra/agents/multilingual-agent.ts"
|
|
140
142
|
import { Agent } from "@mastra/core/agent";
|
|
141
143
|
import { LanguageDetector } from "@mastra/core/processors";
|
|
142
144
|
|
|
143
145
|
export const agent = new Agent({
|
|
146
|
+
id: "multilingual-agent",
|
|
144
147
|
name: "multilingual-agent",
|
|
145
148
|
instructions: "You are a helpful assistant",
|
|
146
149
|
model: "openai/gpt-5.1",
|
|
@@ -1,6 +1,9 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: Message History Processor | Processors"
|
|
3
3
|
description: "Documentation for the MessageHistory processor in Mastra, which handles retrieval and persistence of conversation history."
|
|
4
|
+
packages:
|
|
5
|
+
- "@mastra/core"
|
|
6
|
+
- "@mastra/pg"
|
|
4
7
|
---
|
|
5
8
|
|
|
6
9
|
# MessageHistory
|
|
@@ -9,7 +12,7 @@ The `MessageHistory` is a **hybrid processor** that handles both retrieval and p
|
|
|
9
12
|
|
|
10
13
|
## Usage example
|
|
11
14
|
|
|
12
|
-
```typescript
|
|
15
|
+
```typescript
|
|
13
16
|
import { MessageHistory } from "@mastra/core/processors";
|
|
14
17
|
|
|
15
18
|
const processor = new MessageHistory({
|
|
@@ -83,7 +86,7 @@ const processor = new MessageHistory({
|
|
|
83
86
|
|
|
84
87
|
## Extended usage example
|
|
85
88
|
|
|
86
|
-
```typescript title="src/mastra/agents/memory-agent.ts"
|
|
89
|
+
```typescript title="src/mastra/agents/memory-agent.ts"
|
|
87
90
|
import { Agent } from "@mastra/core/agent";
|
|
88
91
|
import { MessageHistory } from "@mastra/core/processors";
|
|
89
92
|
import { PostgresStorage } from "@mastra/pg";
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: Moderation Processor | Processors"
|
|
3
3
|
description: "Documentation for the ModerationProcessor in Mastra, which provides content moderation using LLM to detect inappropriate content across multiple categories."
|
|
4
|
+
packages:
|
|
5
|
+
- "@mastra/core"
|
|
4
6
|
---
|
|
5
7
|
|
|
6
8
|
# ModerationProcessor
|
|
@@ -9,7 +11,7 @@ The `ModerationProcessor` is a **hybrid processor** that can be used for both in
|
|
|
9
11
|
|
|
10
12
|
## Usage example
|
|
11
13
|
|
|
12
|
-
```typescript
|
|
14
|
+
```typescript
|
|
13
15
|
import { ModerationProcessor } from "@mastra/core/processors";
|
|
14
16
|
|
|
15
17
|
const processor = new ModerationProcessor({
|
|
@@ -113,7 +115,7 @@ const processor = new ModerationProcessor({
|
|
|
113
115
|
},
|
|
114
116
|
{
|
|
115
117
|
name: "processInput",
|
|
116
|
-
type: "(args: { messages:
|
|
118
|
+
type: "(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never; tracingContext?: TracingContext }) => Promise<MastraDBMessage[]>",
|
|
117
119
|
description: "Processes input messages to moderate content before sending to LLM",
|
|
118
120
|
isOptional: false,
|
|
119
121
|
},
|
|
@@ -130,7 +132,7 @@ const processor = new ModerationProcessor({
|
|
|
130
132
|
|
|
131
133
|
### Input processing
|
|
132
134
|
|
|
133
|
-
```typescript title="src/mastra/agents/moderated-agent.ts"
|
|
135
|
+
```typescript title="src/mastra/agents/moderated-agent.ts"
|
|
134
136
|
import { Agent } from "@mastra/core/agent";
|
|
135
137
|
import { ModerationProcessor } from "@mastra/core/processors";
|
|
136
138
|
|
|
@@ -155,7 +157,7 @@ export const agent = new Agent({
|
|
|
155
157
|
|
|
156
158
|
When using `ModerationProcessor` as an output processor, it's recommended to combine it with `BatchPartsProcessor` to optimize performance. The `BatchPartsProcessor` batches stream chunks together before passing them to the moderator, reducing the number of LLM calls required for moderation.
|
|
157
159
|
|
|
158
|
-
```typescript title="src/mastra/agents/output-moderated-agent.ts"
|
|
160
|
+
```typescript title="src/mastra/agents/output-moderated-agent.ts"
|
|
159
161
|
import { Agent } from "@mastra/core/agent";
|
|
160
162
|
import { BatchPartsProcessor, ModerationProcessor } from "@mastra/core/processors";
|
|
161
163
|
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: PII Detector | Processors"
|
|
3
3
|
description: "Documentation for the PIIDetector in Mastra, which detects and redacts personally identifiable information (PII) from AI responses."
|
|
4
|
+
packages:
|
|
5
|
+
- "@mastra/core"
|
|
4
6
|
---
|
|
5
7
|
|
|
6
8
|
# PIIDetector
|
|
@@ -9,7 +11,7 @@ The `PIIDetector` is a **hybrid processor** that can be used for both input and
|
|
|
9
11
|
|
|
10
12
|
## Usage example
|
|
11
13
|
|
|
12
|
-
```typescript
|
|
14
|
+
```typescript
|
|
13
15
|
import { PIIDetector } from "@mastra/core/processors";
|
|
14
16
|
|
|
15
17
|
const processor = new PIIDetector({
|
|
@@ -120,7 +122,7 @@ const processor = new PIIDetector({
|
|
|
120
122
|
},
|
|
121
123
|
{
|
|
122
124
|
name: "processInput",
|
|
123
|
-
type: "(args: { messages:
|
|
125
|
+
type: "(args: { messages: MastraDBMessage[]; abort: (reason?: string) => never; tracingContext?: TracingContext }) => Promise<MastraDBMessage[]>",
|
|
124
126
|
description: "Processes input messages to detect and redact PII before sending to LLM",
|
|
125
127
|
isOptional: false,
|
|
126
128
|
},
|
|
@@ -137,7 +139,7 @@ const processor = new PIIDetector({
|
|
|
137
139
|
|
|
138
140
|
### Input processing
|
|
139
141
|
|
|
140
|
-
```typescript title="src/mastra/agents/private-agent.ts"
|
|
142
|
+
```typescript title="src/mastra/agents/private-agent.ts"
|
|
141
143
|
import { Agent } from "@mastra/core/agent";
|
|
142
144
|
import { PIIDetector } from "@mastra/core/processors";
|
|
143
145
|
|
|
@@ -164,7 +166,7 @@ export const agent = new Agent({
|
|
|
164
166
|
|
|
165
167
|
When using `PIIDetector` as an output processor, it's recommended to combine it with `BatchPartsProcessor` to optimize performance. The `BatchPartsProcessor` batches stream chunks together before passing them to the PII detector, reducing the number of LLM calls required for detection.
|
|
166
168
|
|
|
167
|
-
```typescript title="src/mastra/agents/output-pii-agent.ts"
|
|
169
|
+
```typescript title="src/mastra/agents/output-pii-agent.ts"
|
|
168
170
|
import { Agent } from "@mastra/core/agent";
|
|
169
171
|
import { BatchPartsProcessor, PIIDetector } from "@mastra/core/processors";
|
|
170
172
|
|