@mastra/mcp-docs-server 0.13.39 → 1.0.0-beta.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%2Fai-sdk-v4.md +1 -0
- package/.docs/organized/changelogs/%40internal%2Fchangeset-cli.md +0 -10
- package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +0 -10
- package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +36 -36
- package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +0 -10
- package/.docs/organized/changelogs/%40mastra%2Fagent-builder.md +70 -70
- package/.docs/organized/changelogs/%40mastra%2Fai-sdk.md +40 -40
- package/.docs/organized/changelogs/%40mastra%2Fastra.md +19 -19
- package/.docs/organized/changelogs/%40mastra%2Fauth.md +4 -14
- package/.docs/organized/changelogs/%40mastra%2Fchroma.md +18 -18
- package/.docs/organized/changelogs/%40mastra%2Fclickhouse.md +199 -199
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +220 -220
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare-d1.md +190 -190
- package/.docs/organized/changelogs/%40mastra%2Fcloudflare.md +199 -199
- package/.docs/organized/changelogs/%40mastra%2Fcodemod.md +7 -0
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +210 -210
- package/.docs/organized/changelogs/%40mastra%2Fcouchbase.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +69 -69
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +67 -67
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +70 -70
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +67 -67
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +209 -209
- package/.docs/organized/changelogs/%40mastra%2Fdynamodb.md +191 -191
- package/.docs/organized/changelogs/%40mastra%2Fevals.md +34 -34
- package/.docs/organized/changelogs/%40mastra%2Ffastembed.md +5 -13
- package/.docs/organized/changelogs/%40mastra%2Flance.md +182 -182
- package/.docs/organized/changelogs/%40mastra%2Flibsql.md +199 -199
- package/.docs/organized/changelogs/%40mastra%2Floggers.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +56 -56
- package/.docs/organized/changelogs/%40mastra%2Fmcp-registry-registry.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fmcp.md +65 -65
- package/.docs/organized/changelogs/%40mastra%2Fmemory.md +228 -228
- package/.docs/organized/changelogs/%40mastra%2Fmongodb.md +199 -199
- package/.docs/organized/changelogs/%40mastra%2Fmssql.md +206 -206
- package/.docs/organized/changelogs/%40mastra%2Fopensearch.md +19 -19
- package/.docs/organized/changelogs/%40mastra%2Fpg.md +197 -197
- package/.docs/organized/changelogs/%40mastra%2Fpinecone.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +216 -216
- package/.docs/organized/changelogs/%40mastra%2Fqdrant.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Frag.md +61 -61
- package/.docs/organized/changelogs/%40mastra%2Freact.md +66 -66
- package/.docs/organized/changelogs/%40mastra%2Fs3vectors.md +9 -17
- package/.docs/organized/changelogs/%40mastra%2Fschema-compat.md +6 -30
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +203 -203
- package/.docs/organized/changelogs/%40mastra%2Fturbopuffer.md +16 -16
- package/.docs/organized/changelogs/%40mastra%2Fupstash.md +190 -190
- package/.docs/organized/changelogs/%40mastra%2Fvectorize.md +18 -18
- package/.docs/organized/changelogs/%40mastra%2Fvoice-azure.md +21 -21
- package/.docs/organized/changelogs/%40mastra%2Fvoice-cloudflare.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-deepgram.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-elevenlabs.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-gladia.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google-gemini-live.md +56 -56
- package/.docs/organized/changelogs/%40mastra%2Fvoice-google.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-murf.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai-realtime.md +56 -56
- package/.docs/organized/changelogs/%40mastra%2Fvoice-openai.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-playai.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-sarvam.md +20 -20
- package/.docs/organized/changelogs/%40mastra%2Fvoice-speechify.md +20 -20
- package/.docs/organized/changelogs/create-mastra.md +29 -29
- package/.docs/organized/changelogs/mastra.md +93 -93
- package/.docs/organized/code-examples/a2a.md +4 -2
- package/.docs/organized/code-examples/agui.md +12 -9
- package/.docs/organized/code-examples/ai-sdk-useChat.md +12 -18
- package/.docs/organized/code-examples/ai-sdk-v5.md +4 -2
- package/.docs/organized/code-examples/bird-checker-with-express.md +5 -4
- package/.docs/organized/code-examples/bird-checker-with-nextjs-and-eval.md +4 -3
- package/.docs/organized/code-examples/bird-checker-with-nextjs.md +4 -3
- package/.docs/organized/code-examples/client-side-tools.md +1 -0
- package/.docs/organized/code-examples/crypto-chatbot.md +1 -1
- package/.docs/organized/code-examples/experimental-auth-weather-agent.md +8 -177
- package/.docs/organized/code-examples/fireworks-r1.md +2 -2
- package/.docs/organized/code-examples/heads-up-game.md +10 -7
- package/.docs/organized/code-examples/mcp-configuration.md +5 -3
- package/.docs/organized/code-examples/mcp-registry-registry.md +3 -2
- package/.docs/organized/code-examples/memory-per-resource-example.md +4 -2
- package/.docs/organized/code-examples/memory-todo-agent.md +1 -0
- package/.docs/organized/code-examples/memory-with-context.md +2 -1
- package/.docs/organized/code-examples/memory-with-libsql.md +4 -2
- package/.docs/organized/code-examples/memory-with-mongodb.md +4 -2
- package/.docs/organized/code-examples/memory-with-pg.md +4 -2
- package/.docs/organized/code-examples/memory-with-processors.md +13 -8
- package/.docs/organized/code-examples/memory-with-upstash.md +5 -3
- package/.docs/organized/code-examples/openapi-spec-writer.md +32 -41
- package/.docs/organized/code-examples/quick-start.md +5 -32
- package/.docs/organized/code-examples/stock-price-tool.md +6 -5
- package/.docs/organized/code-examples/weather-agent.md +21 -16
- package/.docs/organized/code-examples/workflow-ai-recruiter.md +3 -2
- package/.docs/organized/code-examples/workflow-with-inline-steps.md +9 -12
- package/.docs/organized/code-examples/workflow-with-memory.md +16 -15
- package/.docs/organized/code-examples/workflow-with-separate-steps.md +2 -2
- package/.docs/organized/code-examples/workflow-with-suspend-resume.md +3 -2
- package/.docs/raw/agents/adding-voice.mdx +27 -22
- package/.docs/raw/agents/agent-memory.mdx +24 -16
- package/.docs/raw/agents/guardrails.mdx +33 -12
- package/.docs/raw/agents/networks.mdx +8 -4
- package/.docs/raw/agents/overview.mdx +23 -17
- package/.docs/raw/agents/using-tools.mdx +11 -8
- package/.docs/raw/auth/auth0.mdx +9 -9
- package/.docs/raw/auth/clerk.mdx +7 -7
- package/.docs/raw/auth/firebase.mdx +9 -9
- package/.docs/raw/auth/index.mdx +6 -6
- package/.docs/raw/auth/jwt.mdx +7 -7
- package/.docs/raw/auth/supabase.mdx +8 -8
- package/.docs/raw/auth/workos.mdx +9 -9
- package/.docs/raw/community/contributing-templates.mdx +3 -3
- package/.docs/raw/community/discord.mdx +1 -1
- package/.docs/raw/course/01-first-agent/03-verifying-installation.md +1 -1
- package/.docs/raw/course/01-first-agent/08-exporting-your-agent.md +2 -1
- package/.docs/raw/course/01-first-agent/16-adding-memory-to-agent.md +2 -1
- package/.docs/raw/course/02-agent-tools-mcp/02-installing-mcp.md +1 -1
- package/.docs/raw/course/02-agent-tools-mcp/31-enhancing-memory-configuration.md +2 -0
- package/.docs/raw/course/03-agent-memory/03-installing-memory.md +1 -1
- package/.docs/raw/course/03-agent-memory/04-creating-basic-memory-agent.md +1 -0
- package/.docs/raw/course/03-agent-memory/10-storage-configuration.md +2 -3
- package/.docs/raw/course/03-agent-memory/13-vector-store-configuration.md +2 -0
- package/.docs/raw/course/03-agent-memory/16-configuring-semantic-recall.md +2 -0
- package/.docs/raw/course/03-agent-memory/18-advanced-configuration-semantic-recall.md +1 -0
- package/.docs/raw/course/03-agent-memory/21-configuring-working-memory.md +2 -0
- package/.docs/raw/course/03-agent-memory/22-custom-working-memory-templates.md +1 -0
- package/.docs/raw/course/03-agent-memory/25-combining-memory-features.md +1 -0
- package/.docs/raw/course/03-agent-memory/27-creating-learning-assistant.md +1 -0
- package/.docs/raw/course/04-workflows/08-running-workflows-programmatically.md +2 -2
- package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +6 -6
- package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +8 -6
- package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +5 -5
- package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +5 -5
- package/.docs/raw/deployment/cloud-providers/index.mdx +11 -8
- package/.docs/raw/deployment/monorepo.mdx +2 -2
- package/.docs/raw/deployment/overview.mdx +2 -2
- package/.docs/raw/deployment/server-deployment.mdx +2 -10
- package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +5 -5
- package/.docs/raw/deployment/serverless-platforms/index.mdx +10 -7
- package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +5 -5
- package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +5 -5
- package/.docs/raw/deployment/web-framework.mdx +8 -8
- package/.docs/raw/{scorers → evals}/custom-scorers.mdx +6 -6
- package/.docs/raw/evals/off-the-shelf-scorers.mdx +50 -0
- package/.docs/raw/{scorers → evals}/overview.mdx +9 -9
- package/.docs/raw/evals/running-in-ci.mdx +113 -0
- package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +26 -25
- package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +1 -1
- package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +17 -17
- package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +4 -1
- package/.docs/raw/frameworks/servers/express.mdx +11 -10
- package/.docs/raw/frameworks/web-frameworks/astro.mdx +18 -18
- package/.docs/raw/frameworks/web-frameworks/next-js.mdx +7 -7
- package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +16 -16
- package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +7 -7
- package/.docs/raw/getting-started/installation.mdx +26 -25
- package/.docs/raw/getting-started/mcp-docs-server.mdx +1 -1
- package/.docs/raw/getting-started/project-structure.mdx +4 -4
- package/.docs/raw/getting-started/studio.mdx +8 -8
- package/.docs/raw/getting-started/templates.mdx +6 -6
- package/.docs/raw/guides/guide/ai-recruiter.mdx +264 -0
- package/.docs/raw/guides/guide/chef-michel.mdx +271 -0
- package/.docs/raw/guides/guide/notes-mcp-server.mdx +450 -0
- package/.docs/raw/guides/guide/research-assistant.mdx +380 -0
- package/.docs/raw/guides/guide/stock-agent.mdx +185 -0
- package/.docs/raw/guides/guide/web-search.mdx +291 -0
- package/.docs/raw/guides/index.mdx +43 -0
- package/.docs/raw/guides/migrations/agentnetwork.mdx +114 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/_template.mdx +50 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/agent.mdx +265 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/cli.mdx +48 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/client.mdx +153 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/evals.mdx +230 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/mastra.mdx +171 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/mcp.mdx +114 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/memory.mdx +241 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/overview.mdx +83 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/processors.mdx +62 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/storage.mdx +270 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/tools.mdx +115 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/tracing.mdx +280 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/vectors.mdx +23 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/voice.mdx +39 -0
- package/.docs/raw/guides/migrations/upgrade-to-v1/workflows.mdx +178 -0
- package/.docs/raw/guides/migrations/vnext-to-standard-apis.mdx +367 -0
- package/.docs/raw/guides/quickstarts/nextjs.mdx +275 -0
- package/.docs/raw/index.mdx +9 -9
- package/.docs/raw/{observability/logging.mdx → logging.mdx} +4 -4
- package/.docs/raw/mastra-cloud/dashboard.mdx +2 -2
- package/.docs/raw/mastra-cloud/observability.mdx +6 -6
- package/.docs/raw/mastra-cloud/overview.mdx +2 -2
- package/.docs/raw/mastra-cloud/setting-up.mdx +4 -4
- package/.docs/raw/memory/conversation-history.mdx +1 -0
- package/.docs/raw/memory/memory-processors.mdx +4 -3
- package/.docs/raw/memory/overview.mdx +10 -6
- package/.docs/raw/memory/semantic-recall.mdx +13 -8
- package/.docs/raw/memory/storage/memory-with-libsql.mdx +12 -7
- package/.docs/raw/memory/storage/memory-with-pg.mdx +11 -6
- package/.docs/raw/memory/storage/memory-with-upstash.mdx +11 -6
- package/.docs/raw/memory/threads-and-resources.mdx +11 -13
- package/.docs/raw/memory/working-memory.mdx +30 -14
- package/.docs/raw/observability/overview.mdx +13 -30
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/arize.mdx +11 -19
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/braintrust.mdx +8 -17
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/cloud.mdx +11 -17
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/default.mdx +16 -20
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/langfuse.mdx +8 -17
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/langsmith.mdx +8 -17
- package/.docs/raw/observability/{ai-tracing → tracing}/exporters/otel.mdx +12 -21
- package/.docs/raw/observability/{ai-tracing → tracing}/overview.mdx +107 -142
- package/.docs/raw/observability/{ai-tracing → tracing}/processors/sensitive-data-filter.mdx +14 -13
- package/.docs/raw/rag/chunking-and-embedding.mdx +5 -5
- package/.docs/raw/rag/overview.mdx +3 -13
- package/.docs/raw/rag/retrieval.mdx +24 -12
- package/.docs/raw/rag/vector-databases.mdx +7 -1
- package/.docs/raw/reference/agents/agent.mdx +35 -30
- package/.docs/raw/reference/agents/generate.mdx +10 -10
- package/.docs/raw/reference/agents/generateLegacy.mdx +8 -8
- package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +21 -15
- package/.docs/raw/reference/agents/getDefaultOptions.mdx +69 -0
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +22 -16
- package/.docs/raw/reference/agents/getDescription.mdx +1 -1
- package/.docs/raw/reference/agents/getInstructions.mdx +8 -8
- package/.docs/raw/reference/agents/getLLM.mdx +9 -9
- package/.docs/raw/reference/agents/getMemory.mdx +9 -9
- package/.docs/raw/reference/agents/getModel.mdx +10 -10
- package/.docs/raw/reference/agents/getVoice.mdx +8 -8
- package/.docs/raw/reference/agents/listAgents.mdx +9 -9
- package/.docs/raw/reference/agents/listScorers.mdx +7 -7
- package/.docs/raw/reference/agents/listTools.mdx +7 -7
- package/.docs/raw/reference/agents/listWorkflows.mdx +7 -7
- package/.docs/raw/reference/agents/network.mdx +11 -10
- package/.docs/raw/reference/auth/auth0.mdx +4 -4
- package/.docs/raw/reference/auth/clerk.mdx +4 -4
- package/.docs/raw/reference/auth/firebase.mdx +6 -6
- package/.docs/raw/reference/auth/jwt.mdx +4 -4
- package/.docs/raw/reference/auth/supabase.mdx +4 -4
- package/.docs/raw/reference/auth/workos.mdx +4 -4
- package/.docs/raw/reference/cli/create-mastra.mdx +10 -10
- package/.docs/raw/reference/cli/mastra.mdx +7 -7
- package/.docs/raw/reference/client-js/agents.mdx +6 -2
- package/.docs/raw/reference/client-js/mastra-client.mdx +7 -7
- package/.docs/raw/reference/client-js/memory.mdx +24 -16
- package/.docs/raw/reference/client-js/observability.mdx +11 -11
- package/.docs/raw/reference/client-js/workflows.mdx +6 -34
- package/.docs/raw/reference/core/getAgent.mdx +1 -1
- package/.docs/raw/reference/core/getAgentById.mdx +1 -1
- package/.docs/raw/reference/core/getDeployer.mdx +2 -2
- package/.docs/raw/reference/core/getLogger.mdx +2 -2
- package/.docs/raw/reference/core/getMCPServer.mdx +31 -15
- package/.docs/raw/reference/core/getMCPServerById.mdx +81 -0
- package/.docs/raw/reference/core/getScorer.mdx +3 -3
- package/.docs/raw/reference/core/getScorerById.mdx +79 -0
- package/.docs/raw/reference/core/getServer.mdx +2 -2
- package/.docs/raw/reference/core/getStorage.mdx +2 -2
- package/.docs/raw/reference/core/getTelemetry.mdx +2 -2
- package/.docs/raw/reference/core/getVector.mdx +2 -2
- package/.docs/raw/reference/core/getWorkflow.mdx +1 -1
- package/.docs/raw/reference/core/listAgents.mdx +1 -1
- package/.docs/raw/reference/core/listLogs.mdx +2 -2
- package/.docs/raw/reference/core/listLogsByRunId.mdx +2 -2
- package/.docs/raw/reference/core/listMCPServers.mdx +65 -0
- package/.docs/raw/reference/core/listScorers.mdx +3 -3
- package/.docs/raw/reference/core/listVectors.mdx +36 -0
- package/.docs/raw/reference/core/listWorkflows.mdx +6 -6
- package/.docs/raw/reference/core/mastra-class.mdx +3 -2
- package/.docs/raw/reference/core/setLogger.mdx +2 -2
- package/.docs/raw/reference/core/setStorage.mdx +3 -2
- package/.docs/raw/reference/core/setTelemetry.mdx +2 -2
- package/.docs/raw/reference/deployer/cloudflare.mdx +2 -2
- package/.docs/raw/reference/deployer/deployer.mdx +0 -6
- package/.docs/raw/reference/deployer/netlify.mdx +2 -2
- package/.docs/raw/reference/deployer/vercel.mdx +3 -3
- package/.docs/raw/reference/evals/answer-relevancy.mdx +164 -126
- package/.docs/raw/reference/{scorers → evals}/answer-similarity.mdx +27 -27
- package/.docs/raw/reference/evals/bias.mdx +149 -115
- package/.docs/raw/reference/evals/completeness.mdx +148 -117
- package/.docs/raw/reference/evals/content-similarity.mdx +126 -113
- package/.docs/raw/reference/evals/context-precision.mdx +290 -133
- package/.docs/raw/reference/{scorers → evals}/context-relevance.mdx +6 -6
- package/.docs/raw/reference/{scorers → evals}/create-scorer.mdx +69 -60
- package/.docs/raw/reference/evals/faithfulness.mdx +163 -121
- package/.docs/raw/reference/evals/hallucination.mdx +159 -132
- package/.docs/raw/reference/evals/keyword-coverage.mdx +169 -125
- package/.docs/raw/reference/{scorers → evals}/mastra-scorer.mdx +7 -5
- package/.docs/raw/reference/{scorers → evals}/noise-sensitivity.mdx +9 -9
- package/.docs/raw/reference/evals/prompt-alignment.mdx +604 -182
- package/.docs/raw/reference/{scorers/run-experiment.mdx → evals/run-evals.mdx} +17 -18
- package/.docs/raw/reference/evals/textual-difference.mdx +149 -117
- package/.docs/raw/reference/evals/tone-consistency.mdx +149 -125
- package/.docs/raw/reference/{scorers → evals}/tool-call-accuracy.mdx +8 -6
- package/.docs/raw/reference/evals/toxicity.mdx +152 -96
- package/.docs/raw/reference/{observability/logging → logging}/pino-logger.mdx +2 -2
- package/.docs/raw/reference/memory/createThread.mdx +5 -5
- package/.docs/raw/reference/memory/deleteMessages.mdx +7 -7
- package/.docs/raw/reference/memory/getThreadById.mdx +4 -4
- package/.docs/raw/reference/memory/listThreadsByResourceId.mdx +110 -0
- package/.docs/raw/reference/memory/memory-class.mdx +13 -9
- package/.docs/raw/reference/memory/query.mdx +58 -57
- package/.docs/raw/reference/memory/recall.mdx +185 -0
- package/.docs/raw/reference/observability/tracing/configuration.mdx +245 -0
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/arize.mdx +13 -13
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/braintrust.mdx +11 -8
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/cloud-exporter.mdx +21 -19
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/console-exporter.mdx +49 -17
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/default-exporter.mdx +42 -41
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/langfuse.mdx +10 -7
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/langsmith.mdx +10 -7
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/otel.mdx +5 -5
- package/.docs/raw/reference/observability/tracing/instances.mdx +168 -0
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/interfaces.mdx +115 -89
- package/.docs/raw/reference/observability/{ai-tracing → tracing}/processors/sensitive-data-filter.mdx +3 -3
- package/.docs/raw/reference/observability/{ai-tracing/span.mdx → tracing/spans.mdx} +59 -41
- package/.docs/raw/reference/processors/batch-parts-processor.mdx +9 -3
- package/.docs/raw/reference/processors/language-detector.mdx +9 -3
- package/.docs/raw/reference/processors/moderation-processor.mdx +9 -3
- package/.docs/raw/reference/processors/pii-detector.mdx +9 -3
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +9 -3
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +9 -3
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +9 -3
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +9 -3
- package/.docs/raw/reference/rag/chunk.mdx +1 -8
- package/.docs/raw/reference/rag/database-config.mdx +7 -7
- package/.docs/raw/reference/rag/metadata-filters.mdx +14 -11
- package/.docs/raw/reference/storage/cloudflare-d1.mdx +1 -1
- package/.docs/raw/reference/storage/cloudflare.mdx +1 -1
- package/.docs/raw/reference/storage/dynamodb.mdx +3 -3
- package/.docs/raw/reference/storage/lance.mdx +1 -1
- package/.docs/raw/reference/storage/libsql.mdx +3 -1
- package/.docs/raw/reference/storage/mongodb.mdx +1 -1
- package/.docs/raw/reference/storage/mssql.mdx +6 -1
- package/.docs/raw/reference/storage/postgresql.mdx +7 -1
- package/.docs/raw/reference/storage/upstash.mdx +2 -1
- package/.docs/raw/reference/streaming/agents/stream.mdx +12 -12
- package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +8 -8
- package/.docs/raw/reference/streaming/workflows/observeStream.mdx +3 -3
- package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +3 -3
- package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +6 -6
- package/.docs/raw/reference/streaming/workflows/stream.mdx +10 -10
- package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +11 -11
- package/.docs/raw/reference/templates/overview.mdx +3 -3
- package/.docs/raw/reference/tools/create-tool.mdx +52 -35
- package/.docs/raw/reference/tools/graph-rag-tool.mdx +15 -15
- package/.docs/raw/reference/tools/mcp-client.mdx +1 -1
- package/.docs/raw/reference/tools/mcp-server.mdx +119 -35
- package/.docs/raw/reference/tools/vector-query-tool.mdx +27 -26
- package/.docs/raw/reference/vectors/couchbase.mdx +8 -2
- package/.docs/raw/reference/vectors/libsql.mdx +2 -1
- package/.docs/raw/reference/vectors/mongodb.mdx +7 -1
- package/.docs/raw/reference/vectors/pg.mdx +3 -0
- package/.docs/raw/reference/vectors/s3vectors.mdx +1 -1
- package/.docs/raw/reference/vectors/upstash.mdx +1 -0
- package/.docs/raw/reference/voice/google-gemini-live.mdx +1 -1
- package/.docs/raw/reference/voice/voice.addTools.mdx +3 -3
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +4 -4
- package/.docs/raw/reference/workflows/run-methods/resume.mdx +14 -14
- package/.docs/raw/reference/workflows/run-methods/start.mdx +17 -17
- package/.docs/raw/reference/workflows/run.mdx +1 -8
- package/.docs/raw/reference/workflows/step.mdx +5 -5
- package/.docs/raw/reference/workflows/workflow-methods/branch.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/commit.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/create-run.mdx +7 -13
- package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/map.mdx +5 -0
- package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow.mdx +1 -1
- package/.docs/raw/server-db/custom-api-routes.mdx +2 -2
- package/.docs/raw/server-db/mastra-client.mdx +23 -22
- package/.docs/raw/server-db/middleware.mdx +7 -7
- package/.docs/raw/server-db/production-server.mdx +4 -4
- package/.docs/raw/server-db/{runtime-context.mdx → request-context.mdx} +46 -45
- package/.docs/raw/server-db/storage.mdx +29 -21
- package/.docs/raw/streaming/events.mdx +3 -3
- package/.docs/raw/streaming/overview.mdx +5 -5
- package/.docs/raw/streaming/tool-streaming.mdx +18 -17
- package/.docs/raw/streaming/workflow-streaming.mdx +1 -1
- package/.docs/raw/tools-mcp/advanced-usage.mdx +5 -4
- package/.docs/raw/tools-mcp/mcp-overview.mdx +33 -20
- package/.docs/raw/tools-mcp/overview.mdx +11 -11
- package/.docs/raw/voice/overview.mdx +63 -43
- package/.docs/raw/voice/speech-to-speech.mdx +5 -3
- package/.docs/raw/voice/speech-to-text.mdx +10 -9
- package/.docs/raw/voice/text-to-speech.mdx +13 -12
- package/.docs/raw/workflows/agents-and-tools.mdx +9 -5
- package/.docs/raw/workflows/control-flow.mdx +3 -3
- package/.docs/raw/workflows/error-handling.mdx +2 -21
- package/.docs/raw/workflows/human-in-the-loop.mdx +7 -4
- package/.docs/raw/workflows/inngest-workflow.mdx +3 -3
- package/.docs/raw/workflows/input-data-mapping.mdx +107 -0
- package/.docs/raw/workflows/overview.mdx +17 -16
- package/.docs/raw/workflows/snapshots.mdx +13 -11
- package/.docs/raw/workflows/suspend-and-resume.mdx +23 -15
- package/CHANGELOG.md +55 -53
- package/README.md +11 -2
- package/dist/{chunk-TUAHUTTB.js → chunk-5NJC7NRO.js} +3 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/prepare-docs/copy-raw.d.ts.map +1 -1
- package/dist/prepare-docs/prepare.js +1 -1
- package/dist/prompts/migration.d.ts +6 -0
- package/dist/prompts/migration.d.ts.map +1 -0
- package/dist/stdio.js +402 -30
- package/dist/tools/migration.d.ts +40 -0
- package/dist/tools/migration.d.ts.map +1 -0
- package/package.json +8 -12
- package/.docs/organized/changelogs/%40mastra%2Fcloud.md +0 -302
- package/.docs/raw/observability/nextjs-tracing.mdx +0 -109
- package/.docs/raw/observability/otel-tracing.mdx +0 -189
- package/.docs/raw/reference/agents/getScorers.mdx +0 -69
- package/.docs/raw/reference/agents/getTools.mdx +0 -69
- package/.docs/raw/reference/agents/getWorkflows.mdx +0 -69
- package/.docs/raw/reference/client-js/workflows-legacy.mdx +0 -143
- package/.docs/raw/reference/core/getAgents.mdx +0 -35
- package/.docs/raw/reference/core/getLogs.mdx +0 -96
- package/.docs/raw/reference/core/getLogsByRunId.mdx +0 -87
- package/.docs/raw/reference/core/getMCPServers.mdx +0 -36
- package/.docs/raw/reference/core/getMemory.mdx +0 -36
- package/.docs/raw/reference/core/getScorerByName.mdx +0 -78
- package/.docs/raw/reference/core/getScorers.mdx +0 -43
- package/.docs/raw/reference/core/getVectors.mdx +0 -36
- package/.docs/raw/reference/core/getWorkflows.mdx +0 -45
- package/.docs/raw/reference/evals/context-position.mdx +0 -197
- package/.docs/raw/reference/evals/context-relevancy.mdx +0 -196
- package/.docs/raw/reference/evals/contextual-recall.mdx +0 -196
- package/.docs/raw/reference/evals/summarization.mdx +0 -212
- package/.docs/raw/reference/legacyWorkflows/after.mdx +0 -89
- package/.docs/raw/reference/legacyWorkflows/afterEvent.mdx +0 -79
- package/.docs/raw/reference/legacyWorkflows/commit.mdx +0 -33
- package/.docs/raw/reference/legacyWorkflows/createRun.mdx +0 -76
- package/.docs/raw/reference/legacyWorkflows/else.mdx +0 -68
- package/.docs/raw/reference/legacyWorkflows/events.mdx +0 -305
- package/.docs/raw/reference/legacyWorkflows/execute.mdx +0 -110
- package/.docs/raw/reference/legacyWorkflows/if.mdx +0 -108
- package/.docs/raw/reference/legacyWorkflows/resume.mdx +0 -158
- package/.docs/raw/reference/legacyWorkflows/resumeWithEvent.mdx +0 -133
- package/.docs/raw/reference/legacyWorkflows/snapshots.mdx +0 -207
- package/.docs/raw/reference/legacyWorkflows/start.mdx +0 -87
- package/.docs/raw/reference/legacyWorkflows/step-class.mdx +0 -100
- package/.docs/raw/reference/legacyWorkflows/step-condition.mdx +0 -137
- package/.docs/raw/reference/legacyWorkflows/step-function.mdx +0 -93
- package/.docs/raw/reference/legacyWorkflows/step-options.mdx +0 -69
- package/.docs/raw/reference/legacyWorkflows/step-retries.mdx +0 -196
- package/.docs/raw/reference/legacyWorkflows/suspend.mdx +0 -70
- package/.docs/raw/reference/legacyWorkflows/then.mdx +0 -72
- package/.docs/raw/reference/legacyWorkflows/until.mdx +0 -168
- package/.docs/raw/reference/legacyWorkflows/watch.mdx +0 -124
- package/.docs/raw/reference/legacyWorkflows/while.mdx +0 -168
- package/.docs/raw/reference/legacyWorkflows/workflow.mdx +0 -234
- package/.docs/raw/reference/memory/getThreadsByResourceId.mdx +0 -79
- package/.docs/raw/reference/memory/getThreadsByResourceIdPaginated.mdx +0 -110
- package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx +0 -185
- package/.docs/raw/reference/observability/ai-tracing/configuration.mdx +0 -238
- package/.docs/raw/reference/observability/otel-tracing/otel-config.mdx +0 -117
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-ax.mdx +0 -81
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-phoenix.mdx +0 -121
- package/.docs/raw/reference/observability/otel-tracing/providers/braintrust.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/dash0.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/index.mdx +0 -20
- package/.docs/raw/reference/observability/otel-tracing/providers/keywordsai.mdx +0 -73
- package/.docs/raw/reference/observability/otel-tracing/providers/laminar.mdx +0 -41
- package/.docs/raw/reference/observability/otel-tracing/providers/langfuse.mdx +0 -84
- package/.docs/raw/reference/observability/otel-tracing/providers/langsmith.mdx +0 -48
- package/.docs/raw/reference/observability/otel-tracing/providers/langwatch.mdx +0 -43
- package/.docs/raw/reference/observability/otel-tracing/providers/new-relic.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/signoz.mdx +0 -40
- package/.docs/raw/reference/observability/otel-tracing/providers/traceloop.mdx +0 -40
- package/.docs/raw/reference/scorers/answer-relevancy.mdx +0 -227
- package/.docs/raw/reference/scorers/bias.mdx +0 -228
- package/.docs/raw/reference/scorers/completeness.mdx +0 -214
- package/.docs/raw/reference/scorers/content-similarity.mdx +0 -197
- package/.docs/raw/reference/scorers/context-precision.mdx +0 -352
- package/.docs/raw/reference/scorers/faithfulness.mdx +0 -241
- package/.docs/raw/reference/scorers/hallucination.mdx +0 -252
- package/.docs/raw/reference/scorers/keyword-coverage.mdx +0 -229
- package/.docs/raw/reference/scorers/prompt-alignment.mdx +0 -668
- package/.docs/raw/reference/scorers/textual-difference.mdx +0 -203
- package/.docs/raw/reference/scorers/tone-consistency.mdx +0 -211
- package/.docs/raw/reference/scorers/toxicity.mdx +0 -228
- package/.docs/raw/reference/workflows/run-methods/watch.mdx +0 -73
- package/.docs/raw/scorers/evals-old-api/custom-eval.mdx +0 -24
- package/.docs/raw/scorers/evals-old-api/overview.mdx +0 -106
- package/.docs/raw/scorers/evals-old-api/running-in-ci.mdx +0 -85
- package/.docs/raw/scorers/evals-old-api/textual-evals.mdx +0 -58
- package/.docs/raw/scorers/off-the-shelf-scorers.mdx +0 -50
- package/.docs/raw/workflows-legacy/control-flow.mdx +0 -774
- package/.docs/raw/workflows-legacy/dynamic-workflows.mdx +0 -239
- package/.docs/raw/workflows-legacy/error-handling.mdx +0 -187
- package/.docs/raw/workflows-legacy/nested-workflows.mdx +0 -360
- package/.docs/raw/workflows-legacy/overview.mdx +0 -182
- package/.docs/raw/workflows-legacy/runtime-variables.mdx +0 -156
- package/.docs/raw/workflows-legacy/steps.mdx +0 -115
- package/.docs/raw/workflows-legacy/suspend-and-resume.mdx +0 -406
- package/.docs/raw/workflows-legacy/variables.mdx +0 -318
|
@@ -0,0 +1,245 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: "Reference: Configuration | Observability | Mastra Docs"
|
|
3
|
+
description: Tracing configuration types and registry functions
|
|
4
|
+
---
|
|
5
|
+
|
|
6
|
+
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
7
|
+
|
|
8
|
+
# Configuration
|
|
9
|
+
|
|
10
|
+
## ObservabilityRegistryConfig
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
interface ObservabilityRegistryConfig {
|
|
14
|
+
default?: { enabled?: boolean };
|
|
15
|
+
configs?: Record<string, Omit<ObservabilityInstanceConfig, "name"> | ObservabilityInstance>;
|
|
16
|
+
configSelector?: ConfigSelector;
|
|
17
|
+
}
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
<PropertiesTable
|
|
21
|
+
props={[
|
|
22
|
+
{
|
|
23
|
+
name: "default",
|
|
24
|
+
type: "{ enabled?: boolean }",
|
|
25
|
+
description: "Enable default configuration with DefaultExporter and CloudExporter",
|
|
26
|
+
required: false,
|
|
27
|
+
},
|
|
28
|
+
{
|
|
29
|
+
name: "configs",
|
|
30
|
+
type: "Record<string, Omit<ObservabilityInstanceConfig, 'name'> | ObservabilityInstance>",
|
|
31
|
+
description: "Named observability instance configurations or pre-instantiated instances",
|
|
32
|
+
required: false,
|
|
33
|
+
},
|
|
34
|
+
{
|
|
35
|
+
name: "configSelector",
|
|
36
|
+
type: "ConfigSelector",
|
|
37
|
+
description: "Runtime configuration selector function",
|
|
38
|
+
required: false,
|
|
39
|
+
},
|
|
40
|
+
]}
|
|
41
|
+
/>
|
|
42
|
+
|
|
43
|
+
## ObservabilityInstanceConfig
|
|
44
|
+
|
|
45
|
+
```typescript
|
|
46
|
+
interface ObservabilityInstanceConfig {
|
|
47
|
+
name: string;
|
|
48
|
+
serviceName: string;
|
|
49
|
+
sampling?: SamplingStrategy;
|
|
50
|
+
exporters?: ObservabilityExporter[];
|
|
51
|
+
spanOutputProcessors?: SpanOutputProcessor[];
|
|
52
|
+
includeInternalSpans?: boolean;
|
|
53
|
+
requestContextKeys?: string[];
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
<PropertiesTable
|
|
58
|
+
props={[
|
|
59
|
+
{
|
|
60
|
+
name: "name",
|
|
61
|
+
type: "string",
|
|
62
|
+
description: "Configuration identifier",
|
|
63
|
+
required: true,
|
|
64
|
+
},
|
|
65
|
+
{
|
|
66
|
+
name: "serviceName",
|
|
67
|
+
type: "string",
|
|
68
|
+
description: "Service name in traces",
|
|
69
|
+
required: true,
|
|
70
|
+
},
|
|
71
|
+
{
|
|
72
|
+
name: "sampling",
|
|
73
|
+
type: "SamplingStrategy",
|
|
74
|
+
description: "Sampling configuration (defaults to ALWAYS)",
|
|
75
|
+
required: false,
|
|
76
|
+
},
|
|
77
|
+
{
|
|
78
|
+
name: "exporters",
|
|
79
|
+
type: "ObservabilityExporter[]",
|
|
80
|
+
description: "Trace data exporters",
|
|
81
|
+
required: false,
|
|
82
|
+
},
|
|
83
|
+
{
|
|
84
|
+
name: "spanOutputProcessors",
|
|
85
|
+
type: "SpanOutputProcessor[]",
|
|
86
|
+
description: "Span output processors",
|
|
87
|
+
required: false,
|
|
88
|
+
},
|
|
89
|
+
{
|
|
90
|
+
name: "includeInternalSpans",
|
|
91
|
+
type: "boolean",
|
|
92
|
+
description: "Include spans internal to Mastra operations",
|
|
93
|
+
required: false,
|
|
94
|
+
},
|
|
95
|
+
{
|
|
96
|
+
name: "requestContextKeys",
|
|
97
|
+
type: "string[]",
|
|
98
|
+
description: "RequestContext keys to extract as metadata (supports dot notation)",
|
|
99
|
+
required: false,
|
|
100
|
+
},
|
|
101
|
+
]}
|
|
102
|
+
/>
|
|
103
|
+
|
|
104
|
+
## SamplingStrategy
|
|
105
|
+
|
|
106
|
+
```typescript
|
|
107
|
+
type SamplingStrategy =
|
|
108
|
+
| { type: "always" }
|
|
109
|
+
| { type: "never" }
|
|
110
|
+
| { type: "ratio"; probability: number }
|
|
111
|
+
| { type: "custom"; sampler: (options?: TracingOptions) => boolean };
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## ConfigSelector
|
|
115
|
+
|
|
116
|
+
```typescript
|
|
117
|
+
type ConfigSelector = (
|
|
118
|
+
options: ConfigSelectorOptions,
|
|
119
|
+
availableConfigs: ReadonlyMap<string, ObservabilityInstance>,
|
|
120
|
+
) => string | undefined;
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
## ConfigSelectorOptions
|
|
124
|
+
|
|
125
|
+
```typescript
|
|
126
|
+
interface ConfigSelectorOptions {
|
|
127
|
+
requestContext?: RequestContext;
|
|
128
|
+
}
|
|
129
|
+
```
|
|
130
|
+
|
|
131
|
+
# Registry Methods
|
|
132
|
+
|
|
133
|
+
The Observability class provides methods for managing observability instances:
|
|
134
|
+
|
|
135
|
+
## registerInstance
|
|
136
|
+
|
|
137
|
+
```typescript
|
|
138
|
+
registerInstance(
|
|
139
|
+
name: string,
|
|
140
|
+
instance: ObservabilityInstance,
|
|
141
|
+
isDefault?: boolean
|
|
142
|
+
): void;
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
Registers an observability instance in the registry.
|
|
146
|
+
|
|
147
|
+
## getInstance
|
|
148
|
+
|
|
149
|
+
```typescript
|
|
150
|
+
getInstance(name: string): ObservabilityInstance | undefined;
|
|
151
|
+
```
|
|
152
|
+
|
|
153
|
+
Retrieves an observability instance by name.
|
|
154
|
+
|
|
155
|
+
## getDefaultInstance
|
|
156
|
+
|
|
157
|
+
```typescript
|
|
158
|
+
getDefaultInstance(): ObservabilityInstance | undefined;
|
|
159
|
+
```
|
|
160
|
+
|
|
161
|
+
Returns the default observability instance.
|
|
162
|
+
|
|
163
|
+
## getSelectedInstance
|
|
164
|
+
|
|
165
|
+
```typescript
|
|
166
|
+
getSelectedInstance(
|
|
167
|
+
options: ConfigSelectorOptions
|
|
168
|
+
): ObservabilityInstance | undefined;
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
Returns the observability instance selected by the config selector or default.
|
|
172
|
+
|
|
173
|
+
## listInstances
|
|
174
|
+
|
|
175
|
+
```typescript
|
|
176
|
+
listInstances(): ReadonlyMap<string, ObservabilityInstance>;
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
Returns all registered observability instances.
|
|
180
|
+
|
|
181
|
+
## hasInstance
|
|
182
|
+
|
|
183
|
+
```typescript
|
|
184
|
+
hasInstance(name: string): boolean;
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
Checks if an observability instance exists.
|
|
188
|
+
|
|
189
|
+
## setConfigSelector
|
|
190
|
+
|
|
191
|
+
```typescript
|
|
192
|
+
setConfigSelector(selector: ConfigSelector): void;
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
Sets the config selector function.
|
|
196
|
+
|
|
197
|
+
## unregisterInstance
|
|
198
|
+
|
|
199
|
+
```typescript
|
|
200
|
+
unregisterInstance(name: string): boolean;
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
Removes an observability instance from the registry.
|
|
204
|
+
|
|
205
|
+
## clear
|
|
206
|
+
|
|
207
|
+
```typescript
|
|
208
|
+
clear(): void;
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
Clears all instances without shutdown.
|
|
212
|
+
|
|
213
|
+
## shutdown
|
|
214
|
+
|
|
215
|
+
```typescript
|
|
216
|
+
async shutdown(): Promise<void>;
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
Shuts down all observability instances and clears the registry.
|
|
220
|
+
|
|
221
|
+
## See Also
|
|
222
|
+
|
|
223
|
+
### Documentation
|
|
224
|
+
|
|
225
|
+
- [Tracing Overview](/docs/v1/observability/tracing/overview) - Concepts and usage guide
|
|
226
|
+
- [Sampling Strategies](/docs/v1/observability/tracing/overview#sampling-strategies) - Sampling configuration details
|
|
227
|
+
- [Multi-Config Setup](/docs/v1/observability/tracing/overview#multi-config-setup) - Using multiple configurations
|
|
228
|
+
|
|
229
|
+
### Reference
|
|
230
|
+
|
|
231
|
+
- [Tracing Classes](/reference/v1/observability/tracing/instances) - Core tracing classes
|
|
232
|
+
- [Interfaces](/reference/v1/observability/tracing/interfaces) - Type definitions
|
|
233
|
+
- [Spans Reference](/reference/v1/observability/tracing/spans) - Span lifecycle
|
|
234
|
+
|
|
235
|
+
### Examples
|
|
236
|
+
|
|
237
|
+
- [Basic Tracing](/examples/v1/observability/basic-tracing) - Getting started
|
|
238
|
+
|
|
239
|
+
### Exporters
|
|
240
|
+
|
|
241
|
+
- [DefaultExporter](/reference/v1/observability/tracing/exporters/default-exporter) - Storage configuration
|
|
242
|
+
- [CloudExporter](/reference/v1/observability/tracing/exporters/cloud-exporter) - Cloud setup
|
|
243
|
+
- [Braintrust](/reference/v1/observability/tracing/exporters/braintrust) - Braintrust integration
|
|
244
|
+
- [Langfuse](/reference/v1/observability/tracing/exporters/langfuse) - Langfuse integration
|
|
245
|
+
- [LangSmith](/reference/v1/observability/tracing/exporters/langsmith) - LangSmith integration
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: ArizeExporter | Observability | Mastra Docs"
|
|
3
|
-
description: Arize exporter for
|
|
3
|
+
description: Arize exporter for Tracing using OpenInference
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
7
7
|
|
|
8
8
|
# ArizeExporter
|
|
9
9
|
|
|
10
|
-
Sends
|
|
10
|
+
Sends Tracing data to Arize Phoenix, Arize AX, or any OpenTelemetry-compatible observability platform that supports OpenInference semantic conventions.
|
|
11
11
|
|
|
12
12
|
## Constructor
|
|
13
13
|
|
|
@@ -18,7 +18,7 @@ new ArizeExporter(config: ArizeExporterConfig)
|
|
|
18
18
|
## ArizeExporterConfig
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
|
|
21
|
+
type ArizeExporterConfig = Omit<OtelExporterConfig, 'provider'> & {
|
|
22
22
|
// Phoenix / OpenTelemetry configuration
|
|
23
23
|
endpoint?: string;
|
|
24
24
|
apiKey?: string;
|
|
@@ -29,15 +29,15 @@ interface ArizeExporterConfig {
|
|
|
29
29
|
// Common configuration
|
|
30
30
|
projectName?: string;
|
|
31
31
|
headers?: Record<string, string>;
|
|
32
|
-
|
|
33
|
-
// Inherited from OtelExporterConfig
|
|
34
|
-
timeout?: number;
|
|
35
|
-
batchSize?: number;
|
|
36
|
-
logLevel?: "debug" | "info" | "warn" | "error";
|
|
37
|
-
resourceAttributes?: Record<string, any>;
|
|
38
32
|
}
|
|
39
33
|
```
|
|
40
34
|
|
|
35
|
+
Inherits from `OtelExporterConfig` (excluding `provider`), which includes:
|
|
36
|
+
- `timeout?: number` - Export timeout in milliseconds (default: 30000)
|
|
37
|
+
- `batchSize?: number` - Number of spans per batch (default: 512)
|
|
38
|
+
- `logLevel?: LogLevel | 'debug' | 'info' | 'warn' | 'error'` - Log level (default: WARN)
|
|
39
|
+
- `resourceAttributes?: Record<string, any>` - Custom resource attributes
|
|
40
|
+
|
|
41
41
|
<PropertiesTable
|
|
42
42
|
props={[
|
|
43
43
|
{
|
|
@@ -103,10 +103,10 @@ interface ArizeExporterConfig {
|
|
|
103
103
|
|
|
104
104
|
## Methods
|
|
105
105
|
|
|
106
|
-
###
|
|
106
|
+
### exportTracingEvent
|
|
107
107
|
|
|
108
108
|
```typescript
|
|
109
|
-
async
|
|
109
|
+
async exportTracingEvent(event: TracingEvent): Promise<void>
|
|
110
110
|
```
|
|
111
111
|
|
|
112
112
|
Exports a tracing event to the configured endpoint.
|
|
@@ -114,7 +114,7 @@ Exports a tracing event to the configured endpoint.
|
|
|
114
114
|
### export
|
|
115
115
|
|
|
116
116
|
```typescript
|
|
117
|
-
async export(spans:
|
|
117
|
+
async export(spans: ReadOnlySpan[]): Promise<void>
|
|
118
118
|
```
|
|
119
119
|
|
|
120
120
|
Batch exports spans using OpenTelemetry with OpenInference semantic conventions.
|
|
@@ -159,6 +159,6 @@ The ArizeExporter implements [OpenInference Semantic Conventions](https://github
|
|
|
159
159
|
|
|
160
160
|
## Related
|
|
161
161
|
|
|
162
|
-
- [ArizeExporter Documentation](/docs/observability/
|
|
162
|
+
- [ArizeExporter Documentation](/docs/v1/observability/tracing/exporters/arize)
|
|
163
163
|
- [Phoenix Documentation](https://docs.arize.com/phoenix)
|
|
164
164
|
- [Arize AX Documentation](https://docs.arize.com/)
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
---
|
|
2
2
|
title: "Reference: BraintrustExporter | Observability | Mastra Docs"
|
|
3
|
-
description: Braintrust exporter for
|
|
3
|
+
description: Braintrust exporter for Tracing
|
|
4
4
|
---
|
|
5
5
|
|
|
6
6
|
import PropertiesTable from "@site/src/components/PropertiesTable";
|
|
7
7
|
|
|
8
8
|
# BraintrustExporter
|
|
9
9
|
|
|
10
|
-
Sends
|
|
10
|
+
Sends Tracing data to Braintrust for eval and observability.
|
|
11
11
|
|
|
12
12
|
## Constructor
|
|
13
13
|
|
|
@@ -18,15 +18,18 @@ new BraintrustExporter(config: BraintrustExporterConfig)
|
|
|
18
18
|
## BraintrustExporterConfig
|
|
19
19
|
|
|
20
20
|
```typescript
|
|
21
|
-
interface BraintrustExporterConfig {
|
|
21
|
+
interface BraintrustExporterConfig extends BaseExporterConfig {
|
|
22
22
|
apiKey?: string;
|
|
23
23
|
endpoint?: string;
|
|
24
24
|
projectName?: string;
|
|
25
|
-
logLevel?: "debug" | "info" | "warn" | "error";
|
|
26
25
|
tuningParameters?: Record<string, any>;
|
|
27
26
|
}
|
|
28
27
|
```
|
|
29
28
|
|
|
29
|
+
Extends `BaseExporterConfig`, which includes:
|
|
30
|
+
- `logger?: IMastraLogger` - Logger instance
|
|
31
|
+
- `logLevel?: LogLevel | 'debug' | 'info' | 'warn' | 'error'` - Log level (default: INFO)
|
|
32
|
+
|
|
30
33
|
<PropertiesTable
|
|
31
34
|
props={[
|
|
32
35
|
{
|
|
@@ -64,10 +67,10 @@ interface BraintrustExporterConfig {
|
|
|
64
67
|
|
|
65
68
|
## Methods
|
|
66
69
|
|
|
67
|
-
###
|
|
70
|
+
### exportTracingEvent
|
|
68
71
|
|
|
69
72
|
```typescript
|
|
70
|
-
async
|
|
73
|
+
async exportTracingEvent(event: TracingEvent): Promise<void>
|
|
71
74
|
```
|
|
72
75
|
|
|
73
76
|
Exports a tracing event to Braintrust.
|
|
@@ -75,7 +78,7 @@ Exports a tracing event to Braintrust.
|
|
|
75
78
|
### export
|
|
76
79
|
|
|
77
80
|
```typescript
|
|
78
|
-
async export(spans:
|
|
81
|
+
async export(spans: ReadOnlySpan[]): Promise<void>
|
|
79
82
|
```
|
|
80
83
|
|
|
81
84
|
Batch exports spans to Braintrust.
|
|
@@ -101,7 +104,7 @@ const exporter = new BraintrustExporter({
|
|
|
101
104
|
|
|
102
105
|
## Span Type Mapping
|
|
103
106
|
|
|
104
|
-
|
|
|
107
|
+
| Span Type | Braintrust Type |
|
|
105
108
|
| --------------------------- | --------------- |
|
|
106
109
|
| `MODEL_GENERATION` | `llm` |
|
|
107
110
|
| `MODEL_CHUNK` | `llm` |
|
package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/cloud-exporter.mdx
RENAMED
|
@@ -29,7 +29,7 @@ new CloudExporter(config?: CloudExporterConfig)
|
|
|
29
29
|
## CloudExporterConfig
|
|
30
30
|
|
|
31
31
|
```typescript
|
|
32
|
-
interface CloudExporterConfig {
|
|
32
|
+
interface CloudExporterConfig extends BaseExporterConfig {
|
|
33
33
|
/** Maximum number of spans per batch. Default: 1000 */
|
|
34
34
|
maxBatchSize?: number;
|
|
35
35
|
|
|
@@ -42,33 +42,34 @@ interface CloudExporterConfig {
|
|
|
42
42
|
/** Cloud access token (from env or config) */
|
|
43
43
|
accessToken?: string;
|
|
44
44
|
|
|
45
|
-
/** Cloud
|
|
45
|
+
/** Cloud observability endpoint */
|
|
46
46
|
endpoint?: string;
|
|
47
|
-
|
|
48
|
-
/** Optional logger */
|
|
49
|
-
logger?: IMastraLogger;
|
|
50
47
|
}
|
|
51
48
|
```
|
|
52
49
|
|
|
50
|
+
Extends `BaseExporterConfig`, which includes:
|
|
51
|
+
- `logger?: IMastraLogger` - Logger instance
|
|
52
|
+
- `logLevel?: LogLevel | 'debug' | 'info' | 'warn' | 'error'` - Log level (default: INFO)
|
|
53
|
+
|
|
53
54
|
## Environment Variables
|
|
54
55
|
|
|
55
56
|
The exporter reads these environment variables if not provided in config:
|
|
56
57
|
|
|
57
58
|
- `MASTRA_CLOUD_ACCESS_TOKEN` - Access token for authentication
|
|
58
|
-
- `
|
|
59
|
+
- `MASTRA_CLOUD_TRACES_ENDPOINT` - Custom endpoint (defaults to `https://api.mastra.ai/ai/spans/publish`)
|
|
59
60
|
|
|
60
61
|
## Properties
|
|
61
62
|
|
|
62
63
|
```typescript
|
|
63
|
-
readonly name = 'mastra-cloud-
|
|
64
|
+
readonly name = 'mastra-cloud-observability-exporter';
|
|
64
65
|
```
|
|
65
66
|
|
|
66
67
|
## Methods
|
|
67
68
|
|
|
68
|
-
###
|
|
69
|
+
### exportTracingEvent
|
|
69
70
|
|
|
70
71
|
```typescript
|
|
71
|
-
async
|
|
72
|
+
async exportTracingEvent(event: TracingEvent): Promise<void>
|
|
72
73
|
```
|
|
73
74
|
|
|
74
75
|
Processes tracing events. Only exports SPAN_ENDED events to Cloud.
|
|
@@ -77,7 +78,7 @@ Processes tracing events. Only exports SPAN_ENDED events to Cloud.
|
|
|
77
78
|
props={[
|
|
78
79
|
{
|
|
79
80
|
name: "event",
|
|
80
|
-
type: "
|
|
81
|
+
type: "TracingEvent",
|
|
81
82
|
description: "The tracing event to export",
|
|
82
83
|
required: true,
|
|
83
84
|
},
|
|
@@ -148,7 +149,7 @@ interface MastraCloudSpanRecord {
|
|
|
148
149
|
## Usage
|
|
149
150
|
|
|
150
151
|
```typescript
|
|
151
|
-
import { CloudExporter } from "@mastra/
|
|
152
|
+
import { CloudExporter } from "@mastra/observability";
|
|
152
153
|
|
|
153
154
|
// Uses environment variable for token
|
|
154
155
|
const exporter = new CloudExporter();
|
|
@@ -158,6 +159,7 @@ const customExporter = new CloudExporter({
|
|
|
158
159
|
accessToken: "your-token",
|
|
159
160
|
maxBatchSize: 500,
|
|
160
161
|
maxBatchWaitMs: 2000,
|
|
162
|
+
logLevel: 'debug'
|
|
161
163
|
});
|
|
162
164
|
```
|
|
163
165
|
|
|
@@ -165,17 +167,17 @@ const customExporter = new CloudExporter({
|
|
|
165
167
|
|
|
166
168
|
### Documentation
|
|
167
169
|
|
|
168
|
-
- [
|
|
169
|
-
- [Exporters](/docs/observability/
|
|
170
|
+
- [Tracing Overview](/docs/v1/observability/tracing/overview) - Complete guide
|
|
171
|
+
- [Exporters](/docs/v1/observability/tracing/overview#exporters) - Exporter concepts
|
|
170
172
|
|
|
171
173
|
### Other Exporters
|
|
172
174
|
|
|
173
|
-
- [DefaultExporter](/reference/observability/
|
|
174
|
-
- [ConsoleExporter](/reference/observability/
|
|
175
|
-
- [Langfuse](/reference/observability/
|
|
176
|
-
- [Braintrust](/reference/observability/
|
|
175
|
+
- [DefaultExporter](/reference/v1/observability/tracing/exporters/default-exporter) - Storage persistence
|
|
176
|
+
- [ConsoleExporter](/reference/v1/observability/tracing/exporters/console-exporter) - Debug output
|
|
177
|
+
- [Langfuse](/reference/v1/observability/tracing/exporters/langfuse) - Langfuse integration
|
|
178
|
+
- [Braintrust](/reference/v1/observability/tracing/exporters/braintrust) - Braintrust integration
|
|
177
179
|
|
|
178
180
|
### Reference
|
|
179
181
|
|
|
180
|
-
- [Configuration](/reference/observability/
|
|
181
|
-
- [Interfaces](/reference/observability/
|
|
182
|
+
- [Configuration](/reference/v1/observability/tracing/configuration) - Configuration options
|
|
183
|
+
- [Interfaces](/reference/v1/observability/tracing/interfaces) - Type definitions
|
package/.docs/raw/reference/observability/{ai-tracing → tracing}/exporters/console-exporter.mdx
RENAMED
|
@@ -12,7 +12,27 @@ Outputs trace events to the console for debugging and development.
|
|
|
12
12
|
## Constructor
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
new ConsoleExporter(
|
|
15
|
+
new ConsoleExporter(config?: BaseExporterConfig)
|
|
16
|
+
```
|
|
17
|
+
|
|
18
|
+
<PropertiesTable
|
|
19
|
+
props={[
|
|
20
|
+
{
|
|
21
|
+
name: "config",
|
|
22
|
+
type: "BaseExporterConfig",
|
|
23
|
+
description: "Configuration options",
|
|
24
|
+
required: false,
|
|
25
|
+
},
|
|
26
|
+
]}
|
|
27
|
+
/>
|
|
28
|
+
|
|
29
|
+
## BaseExporterConfig
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
interface BaseExporterConfig {
|
|
33
|
+
logger?: IMastraLogger;
|
|
34
|
+
logLevel?: LogLevel | 'debug' | 'info' | 'warn' | 'error';
|
|
35
|
+
}
|
|
16
36
|
```
|
|
17
37
|
|
|
18
38
|
<PropertiesTable
|
|
@@ -20,8 +40,13 @@ new ConsoleExporter(logger?: IMastraLogger)
|
|
|
20
40
|
{
|
|
21
41
|
name: "logger",
|
|
22
42
|
type: "IMastraLogger",
|
|
23
|
-
description:
|
|
24
|
-
|
|
43
|
+
description: "Logger instance (falls back to ConsoleLogger with INFO level)",
|
|
44
|
+
required: false,
|
|
45
|
+
},
|
|
46
|
+
{
|
|
47
|
+
name: "logLevel",
|
|
48
|
+
type: "LogLevel | 'debug' | 'info' | 'warn' | 'error'",
|
|
49
|
+
description: "Log level for the exporter (default: INFO)",
|
|
25
50
|
required: false,
|
|
26
51
|
},
|
|
27
52
|
]}
|
|
@@ -35,10 +60,10 @@ readonly name = 'tracing-console-exporter';
|
|
|
35
60
|
|
|
36
61
|
## Methods
|
|
37
62
|
|
|
38
|
-
###
|
|
63
|
+
### exportTracingEvent
|
|
39
64
|
|
|
40
65
|
```typescript
|
|
41
|
-
async
|
|
66
|
+
async exportTracingEvent(event: TracingEvent): Promise<void>
|
|
42
67
|
```
|
|
43
68
|
|
|
44
69
|
Exports a tracing event to the console.
|
|
@@ -47,7 +72,7 @@ Exports a tracing event to the console.
|
|
|
47
72
|
props={[
|
|
48
73
|
{
|
|
49
74
|
name: "event",
|
|
50
|
-
type: "
|
|
75
|
+
type: "TracingEvent",
|
|
51
76
|
description: "The tracing event to export",
|
|
52
77
|
required: true,
|
|
53
78
|
},
|
|
@@ -113,15 +138,22 @@ The exporter outputs different formats based on event type:
|
|
|
113
138
|
## Usage
|
|
114
139
|
|
|
115
140
|
```typescript
|
|
116
|
-
import { ConsoleExporter } from "@mastra/
|
|
141
|
+
import { ConsoleExporter } from "@mastra/observability";
|
|
117
142
|
import { ConsoleLogger, LogLevel } from "@mastra/core/logger";
|
|
118
143
|
|
|
119
144
|
// Use default logger (INFO level)
|
|
120
145
|
const exporter = new ConsoleExporter();
|
|
121
146
|
|
|
122
|
-
// Use custom
|
|
147
|
+
// Use custom log level
|
|
148
|
+
const exporter = new ConsoleExporter({
|
|
149
|
+
logLevel: 'debug'
|
|
150
|
+
});
|
|
151
|
+
|
|
152
|
+
// Use custom logger instance
|
|
123
153
|
const customLogger = new ConsoleLogger({ level: LogLevel.DEBUG });
|
|
124
|
-
const exporterWithLogger = new ConsoleExporter(
|
|
154
|
+
const exporterWithLogger = new ConsoleExporter({
|
|
155
|
+
logger: customLogger
|
|
156
|
+
});
|
|
125
157
|
```
|
|
126
158
|
|
|
127
159
|
## Implementation Details
|
|
@@ -136,17 +168,17 @@ const exporterWithLogger = new ConsoleExporter(customLogger);
|
|
|
136
168
|
|
|
137
169
|
### Documentation
|
|
138
170
|
|
|
139
|
-
- [
|
|
140
|
-
- [Exporters](/docs/observability/
|
|
171
|
+
- [Tracing Overview](/docs/v1/observability/tracing/overview) - Complete guide
|
|
172
|
+
- [Exporters](/docs/v1/observability/tracing/overview#exporters) - Exporter concepts
|
|
141
173
|
|
|
142
174
|
### Other Exporters
|
|
143
175
|
|
|
144
|
-
- [DefaultExporter](/reference/observability/
|
|
145
|
-
- [CloudExporter](/reference/observability/
|
|
146
|
-
- [Langfuse](/reference/observability/
|
|
147
|
-
- [Braintrust](/reference/observability/
|
|
176
|
+
- [DefaultExporter](/reference/v1/observability/tracing/exporters/default-exporter) - Storage persistence
|
|
177
|
+
- [CloudExporter](/reference/v1/observability/tracing/exporters/cloud-exporter) - Mastra Cloud
|
|
178
|
+
- [Langfuse](/reference/v1/observability/tracing/exporters/langfuse) - Langfuse integration
|
|
179
|
+
- [Braintrust](/reference/v1/observability/tracing/exporters/braintrust) - Braintrust integration
|
|
148
180
|
|
|
149
181
|
### Reference
|
|
150
182
|
|
|
151
|
-
- [Configuration](/reference/observability/
|
|
152
|
-
- [Interfaces](/reference/observability/
|
|
183
|
+
- [Configuration](/reference/v1/observability/tracing/configuration) - Configuration options
|
|
184
|
+
- [Interfaces](/reference/v1/observability/tracing/interfaces) - Type definitions
|