@mastra/mcp-docs-server 0.13.37 → 0.13.38
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 +2 -0
- package/.docs/organized/changelogs/%40internal%2Fexternal-types.md +2 -0
- package/.docs/organized/changelogs/%40internal%2Fstorage-test-utils.md +8 -8
- package/.docs/organized/changelogs/%40internal%2Ftypes-builder.md +2 -0
- package/.docs/organized/changelogs/%40mastra%2Fclient-js.md +23 -23
- package/.docs/organized/changelogs/%40mastra%2Fcore.md +69 -69
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloud.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-cloudflare.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-netlify.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Fdeployer-vercel.md +17 -17
- package/.docs/organized/changelogs/%40mastra%2Fdeployer.md +25 -25
- package/.docs/organized/changelogs/%40mastra%2Fmcp-docs-server.md +15 -15
- package/.docs/organized/changelogs/%40mastra%2Fplayground-ui.md +27 -27
- package/.docs/organized/changelogs/%40mastra%2Freact.md +15 -15
- package/.docs/organized/changelogs/%40mastra%2Fserver.md +23 -23
- package/.docs/organized/changelogs/create-mastra.md +5 -5
- package/.docs/organized/changelogs/mastra.md +17 -17
- package/.docs/raw/agents/adding-voice.mdx +20 -9
- package/.docs/raw/agents/agent-memory.mdx +55 -39
- package/.docs/raw/agents/guardrails.mdx +68 -61
- package/.docs/raw/agents/networks.mdx +50 -46
- package/.docs/raw/agents/overview.mdx +125 -88
- package/.docs/raw/agents/using-tools.mdx +14 -15
- package/.docs/raw/auth/auth0.mdx +28 -27
- package/.docs/raw/auth/clerk.mdx +22 -20
- package/.docs/raw/auth/firebase.mdx +42 -39
- package/.docs/raw/auth/index.mdx +1 -1
- package/.docs/raw/auth/jwt.mdx +18 -16
- package/.docs/raw/auth/supabase.mdx +20 -18
- package/.docs/raw/auth/workos.mdx +32 -26
- package/.docs/raw/community/contributing-templates.mdx +7 -7
- package/.docs/raw/community/discord.mdx +2 -2
- package/.docs/raw/community/licensing.mdx +1 -1
- package/.docs/raw/course/03-agent-memory/26-updating-mastra-export-comprehensive.md +0 -32
- package/.docs/raw/deployment/cloud-providers/amazon-ec2.mdx +41 -22
- package/.docs/raw/deployment/cloud-providers/aws-lambda.mdx +48 -29
- package/.docs/raw/deployment/cloud-providers/azure-app-services.mdx +52 -24
- package/.docs/raw/deployment/cloud-providers/digital-ocean.mdx +86 -55
- package/.docs/raw/deployment/cloud-providers/index.mdx +16 -13
- package/.docs/raw/deployment/monorepo.mdx +32 -42
- package/.docs/raw/deployment/overview.mdx +15 -15
- package/.docs/raw/deployment/server-deployment.mdx +18 -23
- package/.docs/raw/deployment/serverless-platforms/cloudflare-deployer.mdx +16 -17
- package/.docs/raw/deployment/serverless-platforms/index.mdx +15 -12
- package/.docs/raw/deployment/serverless-platforms/netlify-deployer.mdx +14 -23
- package/.docs/raw/deployment/serverless-platforms/vercel-deployer.mdx +16 -23
- package/.docs/raw/deployment/web-framework.mdx +14 -14
- package/.docs/raw/frameworks/agentic-uis/ai-sdk.mdx +138 -145
- package/.docs/raw/frameworks/agentic-uis/assistant-ui.mdx +54 -43
- package/.docs/raw/frameworks/agentic-uis/cedar-os.mdx +51 -36
- package/.docs/raw/frameworks/agentic-uis/copilotkit.mdx +161 -120
- package/.docs/raw/frameworks/agentic-uis/openrouter.mdx +59 -48
- package/.docs/raw/frameworks/servers/express.mdx +45 -44
- package/.docs/raw/frameworks/web-frameworks/astro.mdx +245 -162
- package/.docs/raw/frameworks/web-frameworks/next-js.mdx +112 -69
- package/.docs/raw/frameworks/web-frameworks/sveltekit.mdx +189 -164
- package/.docs/raw/frameworks/web-frameworks/vite-react.mdx +94 -81
- package/.docs/raw/getting-started/installation.mdx +164 -133
- package/.docs/raw/getting-started/mcp-docs-server.mdx +36 -39
- package/.docs/raw/getting-started/project-structure.mdx +34 -42
- package/.docs/raw/getting-started/studio.mdx +40 -58
- package/.docs/raw/getting-started/templates.mdx +22 -27
- package/.docs/raw/index.mdx +9 -9
- package/.docs/raw/mastra-cloud/dashboard.mdx +10 -10
- package/.docs/raw/mastra-cloud/observability.mdx +7 -8
- package/.docs/raw/mastra-cloud/overview.mdx +16 -22
- package/.docs/raw/mastra-cloud/setting-up.mdx +33 -20
- package/.docs/raw/memory/conversation-history.mdx +2 -2
- package/.docs/raw/memory/overview.mdx +21 -23
- package/.docs/raw/memory/semantic-recall.mdx +14 -13
- package/.docs/raw/memory/storage/memory-with-libsql.mdx +27 -28
- package/.docs/raw/memory/storage/memory-with-pg.mdx +26 -26
- package/.docs/raw/memory/storage/memory-with-upstash.mdx +26 -27
- package/.docs/raw/memory/threads-and-resources.mdx +23 -20
- package/.docs/raw/memory/working-memory.mdx +27 -38
- package/.docs/raw/observability/ai-tracing/exporters/arize.mdx +30 -29
- package/.docs/raw/observability/ai-tracing/exporters/braintrust.mdx +8 -9
- package/.docs/raw/observability/ai-tracing/exporters/cloud.mdx +17 -16
- package/.docs/raw/observability/ai-tracing/exporters/default.mdx +31 -32
- package/.docs/raw/observability/ai-tracing/exporters/langfuse.mdx +18 -17
- package/.docs/raw/observability/ai-tracing/exporters/langsmith.mdx +14 -14
- package/.docs/raw/observability/ai-tracing/exporters/otel.mdx +56 -46
- package/.docs/raw/observability/ai-tracing/overview.mdx +145 -122
- package/.docs/raw/observability/ai-tracing/processors/sensitive-data-filter.mdx +57 -36
- package/.docs/raw/observability/logging.mdx +14 -17
- package/.docs/raw/observability/nextjs-tracing.mdx +5 -5
- package/.docs/raw/observability/otel-tracing.mdx +17 -18
- package/.docs/raw/observability/overview.mdx +14 -10
- package/.docs/raw/rag/chunking-and-embedding.mdx +10 -8
- package/.docs/raw/rag/overview.mdx +5 -5
- package/.docs/raw/rag/retrieval.mdx +125 -107
- package/.docs/raw/rag/vector-databases.mdx +232 -223
- package/.docs/raw/reference/agents/agent.mdx +54 -41
- package/.docs/raw/reference/agents/generate.mdx +367 -261
- package/.docs/raw/reference/agents/generateLegacy.mdx +260 -178
- package/.docs/raw/reference/agents/getDefaultGenerateOptions.mdx +7 -5
- package/.docs/raw/reference/agents/getDefaultStreamOptions.mdx +7 -5
- package/.docs/raw/reference/agents/getDescription.mdx +3 -2
- package/.docs/raw/reference/agents/getInstructions.mdx +7 -5
- package/.docs/raw/reference/agents/getLLM.mdx +11 -7
- package/.docs/raw/reference/agents/getMemory.mdx +7 -5
- package/.docs/raw/reference/agents/getModel.mdx +7 -5
- package/.docs/raw/reference/agents/getScorers.mdx +7 -5
- package/.docs/raw/reference/agents/getTools.mdx +7 -5
- package/.docs/raw/reference/agents/getVoice.mdx +7 -5
- package/.docs/raw/reference/agents/getWorkflows.mdx +7 -5
- package/.docs/raw/reference/agents/listAgents.mdx +6 -4
- package/.docs/raw/reference/agents/network.mdx +171 -116
- package/.docs/raw/reference/auth/auth0.mdx +18 -14
- package/.docs/raw/reference/auth/clerk.mdx +15 -12
- package/.docs/raw/reference/auth/firebase.mdx +23 -16
- package/.docs/raw/reference/auth/jwt.mdx +7 -6
- package/.docs/raw/reference/auth/supabase.mdx +13 -10
- package/.docs/raw/reference/auth/workos.mdx +17 -13
- package/.docs/raw/reference/cli/create-mastra.mdx +61 -44
- package/.docs/raw/reference/cli/mastra.mdx +11 -11
- package/.docs/raw/reference/client-js/agents.mdx +40 -43
- package/.docs/raw/reference/client-js/error-handling.mdx +1 -1
- package/.docs/raw/reference/client-js/logs.mdx +1 -1
- package/.docs/raw/reference/client-js/mastra-client.mdx +21 -13
- package/.docs/raw/reference/client-js/memory.mdx +6 -2
- package/.docs/raw/reference/client-js/observability.mdx +10 -9
- package/.docs/raw/reference/client-js/telemetry.mdx +1 -1
- package/.docs/raw/reference/client-js/tools.mdx +1 -1
- package/.docs/raw/reference/client-js/vectors.mdx +1 -1
- package/.docs/raw/reference/client-js/workflows-legacy.mdx +1 -1
- package/.docs/raw/reference/client-js/workflows.mdx +7 -7
- package/.docs/raw/reference/core/getAgent.mdx +6 -5
- package/.docs/raw/reference/core/getAgentById.mdx +5 -4
- package/.docs/raw/reference/core/getAgents.mdx +3 -3
- package/.docs/raw/reference/core/getDeployer.mdx +4 -3
- package/.docs/raw/reference/core/getLogger.mdx +4 -3
- package/.docs/raw/reference/core/getLogs.mdx +10 -6
- package/.docs/raw/reference/core/getLogsByRunId.mdx +8 -5
- package/.docs/raw/reference/core/getMCPServer.mdx +8 -5
- package/.docs/raw/reference/core/getMCPServers.mdx +4 -3
- package/.docs/raw/reference/core/getMemory.mdx +4 -3
- package/.docs/raw/reference/core/getScorer.mdx +15 -12
- package/.docs/raw/reference/core/getScorerByName.mdx +12 -9
- package/.docs/raw/reference/core/getScorers.mdx +3 -2
- package/.docs/raw/reference/core/getServer.mdx +4 -3
- package/.docs/raw/reference/core/getStorage.mdx +4 -3
- package/.docs/raw/reference/core/getTelemetry.mdx +4 -3
- package/.docs/raw/reference/core/getVector.mdx +6 -4
- package/.docs/raw/reference/core/getVectors.mdx +4 -3
- package/.docs/raw/reference/core/getWorkflow.mdx +7 -4
- package/.docs/raw/reference/core/getWorkflows.mdx +5 -3
- package/.docs/raw/reference/core/mastra-class.mdx +16 -16
- package/.docs/raw/reference/core/setLogger.mdx +6 -4
- package/.docs/raw/reference/core/setStorage.mdx +4 -4
- package/.docs/raw/reference/core/setTelemetry.mdx +4 -3
- package/.docs/raw/reference/deployer/cloudflare.mdx +11 -7
- package/.docs/raw/reference/deployer/deployer.mdx +2 -1
- package/.docs/raw/reference/deployer/netlify.mdx +4 -4
- package/.docs/raw/reference/deployer/vercel.mdx +6 -6
- package/.docs/raw/reference/evals/answer-relevancy.mdx +4 -5
- package/.docs/raw/reference/evals/bias.mdx +4 -5
- package/.docs/raw/reference/evals/completeness.mdx +4 -5
- package/.docs/raw/reference/evals/content-similarity.mdx +4 -5
- package/.docs/raw/reference/evals/context-position.mdx +4 -5
- package/.docs/raw/reference/evals/context-precision.mdx +4 -5
- package/.docs/raw/reference/evals/context-relevancy.mdx +4 -5
- package/.docs/raw/reference/evals/contextual-recall.mdx +4 -5
- package/.docs/raw/reference/evals/faithfulness.mdx +4 -5
- package/.docs/raw/reference/evals/hallucination.mdx +4 -6
- package/.docs/raw/reference/evals/keyword-coverage.mdx +4 -5
- package/.docs/raw/reference/evals/prompt-alignment.mdx +4 -6
- package/.docs/raw/reference/evals/summarization.mdx +4 -6
- package/.docs/raw/reference/evals/textual-difference.mdx +4 -5
- package/.docs/raw/reference/evals/tone-consistency.mdx +4 -7
- package/.docs/raw/reference/evals/toxicity.mdx +4 -5
- package/.docs/raw/reference/index.mdx +3 -3
- package/.docs/raw/reference/legacyWorkflows/after.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/afterEvent.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/commit.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/createRun.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/else.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/events.mdx +7 -7
- package/.docs/raw/reference/legacyWorkflows/execute.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/if.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/resume.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/resumeWithEvent.mdx +6 -6
- package/.docs/raw/reference/legacyWorkflows/snapshots.mdx +6 -6
- package/.docs/raw/reference/legacyWorkflows/start.mdx +6 -6
- package/.docs/raw/reference/legacyWorkflows/step-class.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/step-condition.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/step-function.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/step-options.mdx +6 -6
- package/.docs/raw/reference/legacyWorkflows/step-retries.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/suspend.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/then.mdx +5 -5
- package/.docs/raw/reference/legacyWorkflows/until.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/watch.mdx +3 -3
- package/.docs/raw/reference/legacyWorkflows/while.mdx +4 -4
- package/.docs/raw/reference/legacyWorkflows/workflow.mdx +7 -7
- package/.docs/raw/reference/memory/createThread.mdx +10 -10
- package/.docs/raw/reference/memory/deleteMessages.mdx +7 -5
- package/.docs/raw/reference/memory/getThreadById.mdx +6 -5
- package/.docs/raw/reference/memory/getThreadsByResourceId.mdx +11 -10
- package/.docs/raw/reference/memory/getThreadsByResourceIdPaginated.mdx +10 -9
- package/.docs/raw/reference/memory/{Memory.mdx → memory-class.mdx} +53 -46
- package/.docs/raw/reference/memory/query.mdx +39 -25
- package/.docs/raw/reference/observability/ai-tracing/ai-tracing.mdx +9 -5
- package/.docs/raw/reference/observability/ai-tracing/configuration.mdx +26 -22
- package/.docs/raw/reference/observability/ai-tracing/exporters/arize.mdx +16 -12
- package/.docs/raw/reference/observability/ai-tracing/exporters/braintrust.mdx +14 -14
- package/.docs/raw/reference/observability/ai-tracing/exporters/cloud-exporter.mdx +16 -11
- package/.docs/raw/reference/observability/ai-tracing/exporters/console-exporter.mdx +10 -6
- package/.docs/raw/reference/observability/ai-tracing/exporters/default-exporter.mdx +23 -15
- package/.docs/raw/reference/observability/ai-tracing/exporters/langfuse.mdx +6 -6
- package/.docs/raw/reference/observability/ai-tracing/exporters/langsmith.mdx +13 -13
- package/.docs/raw/reference/observability/ai-tracing/exporters/otel.mdx +44 -36
- package/.docs/raw/reference/observability/ai-tracing/interfaces.mdx +115 -106
- package/.docs/raw/reference/observability/ai-tracing/processors/sensitive-data-filter.mdx +37 -32
- package/.docs/raw/reference/observability/ai-tracing/span.mdx +29 -26
- package/.docs/raw/reference/observability/logging/pino-logger.mdx +13 -15
- package/.docs/raw/reference/observability/otel-tracing/otel-config.mdx +2 -2
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-ax.mdx +3 -3
- package/.docs/raw/reference/observability/otel-tracing/providers/arize-phoenix.mdx +2 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/dash0.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/index.mdx +12 -14
- package/.docs/raw/reference/observability/otel-tracing/providers/keywordsai.mdx +3 -3
- package/.docs/raw/reference/observability/otel-tracing/providers/laminar.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/langfuse.mdx +4 -4
- package/.docs/raw/reference/observability/otel-tracing/providers/langsmith.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/langwatch.mdx +2 -2
- package/.docs/raw/reference/observability/otel-tracing/providers/new-relic.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/signoz.mdx +1 -1
- package/.docs/raw/reference/observability/otel-tracing/providers/traceloop.mdx +1 -1
- package/.docs/raw/reference/processors/batch-parts-processor.mdx +13 -10
- package/.docs/raw/reference/processors/language-detector.mdx +27 -17
- package/.docs/raw/reference/processors/moderation-processor.mdx +26 -17
- package/.docs/raw/reference/processors/pii-detector.mdx +28 -18
- package/.docs/raw/reference/processors/prompt-injection-detector.mdx +25 -17
- package/.docs/raw/reference/processors/system-prompt-scrubber.mdx +26 -17
- package/.docs/raw/reference/processors/token-limiter-processor.mdx +22 -15
- package/.docs/raw/reference/processors/unicode-normalizer.mdx +13 -12
- package/.docs/raw/reference/rag/chunk.mdx +41 -23
- package/.docs/raw/reference/rag/database-config.mdx +56 -38
- package/.docs/raw/reference/rag/document.mdx +1 -1
- package/.docs/raw/reference/rag/embeddings.mdx +1 -1
- package/.docs/raw/reference/rag/extract-params.mdx +1 -1
- package/.docs/raw/reference/rag/graph-rag.mdx +1 -1
- package/.docs/raw/reference/rag/metadata-filters.mdx +23 -26
- package/.docs/raw/reference/rag/rerank.mdx +1 -1
- package/.docs/raw/reference/rag/rerankWithScorer.mdx +2 -2
- package/.docs/raw/reference/scorers/answer-relevancy.mdx +35 -17
- package/.docs/raw/reference/scorers/answer-similarity.mdx +84 -68
- package/.docs/raw/reference/scorers/bias.mdx +22 -19
- package/.docs/raw/reference/scorers/completeness.mdx +21 -16
- package/.docs/raw/reference/scorers/content-similarity.mdx +12 -10
- package/.docs/raw/reference/scorers/context-precision.mdx +73 -64
- package/.docs/raw/reference/scorers/context-relevance.mdx +142 -126
- package/.docs/raw/reference/scorers/create-scorer.mdx +93 -61
- package/.docs/raw/reference/scorers/faithfulness.mdx +21 -13
- package/.docs/raw/reference/scorers/hallucination.mdx +17 -12
- package/.docs/raw/reference/scorers/keyword-coverage.mdx +32 -27
- package/.docs/raw/reference/scorers/mastra-scorer.mdx +39 -33
- package/.docs/raw/reference/scorers/noise-sensitivity.mdx +203 -152
- package/.docs/raw/reference/scorers/prompt-alignment.mdx +186 -132
- package/.docs/raw/reference/scorers/run-experiment.mdx +40 -31
- package/.docs/raw/reference/scorers/textual-difference.mdx +25 -26
- package/.docs/raw/reference/scorers/tone-consistency.mdx +29 -26
- package/.docs/raw/reference/scorers/tool-call-accuracy.mdx +180 -176
- package/.docs/raw/reference/scorers/toxicity.mdx +35 -31
- 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 +1 -1
- package/.docs/raw/reference/storage/lance.mdx +1 -1
- package/.docs/raw/reference/storage/libsql.mdx +2 -2
- package/.docs/raw/reference/storage/mongodb.mdx +4 -5
- package/.docs/raw/reference/storage/mssql.mdx +5 -4
- package/.docs/raw/reference/storage/postgresql.mdx +35 -33
- package/.docs/raw/reference/storage/upstash.mdx +6 -5
- package/.docs/raw/reference/streaming/ChunkType.mdx +788 -314
- package/.docs/raw/reference/streaming/agents/MastraModelOutput.mdx +265 -109
- package/.docs/raw/reference/streaming/agents/stream.mdx +375 -266
- package/.docs/raw/reference/streaming/agents/streamLegacy.mdx +233 -162
- package/.docs/raw/reference/streaming/workflows/observeStream.mdx +4 -4
- package/.docs/raw/reference/streaming/workflows/observeStreamVNext.mdx +5 -5
- package/.docs/raw/reference/streaming/workflows/resumeStreamVNext.mdx +24 -20
- package/.docs/raw/reference/streaming/workflows/stream.mdx +35 -26
- package/.docs/raw/reference/streaming/workflows/streamVNext.mdx +36 -27
- package/.docs/raw/reference/templates/overview.mdx +16 -39
- package/.docs/raw/reference/tools/client.mdx +1 -1
- package/.docs/raw/reference/tools/create-tool.mdx +45 -35
- package/.docs/raw/reference/tools/document-chunker-tool.mdx +2 -2
- package/.docs/raw/reference/tools/graph-rag-tool.mdx +12 -12
- package/.docs/raw/reference/tools/mcp-client.mdx +70 -64
- package/.docs/raw/reference/tools/mcp-server.mdx +91 -78
- package/.docs/raw/reference/tools/vector-query-tool.mdx +48 -38
- package/.docs/raw/reference/vectors/astra.mdx +1 -1
- package/.docs/raw/reference/vectors/chroma.mdx +25 -19
- package/.docs/raw/reference/vectors/couchbase.mdx +4 -4
- package/.docs/raw/reference/vectors/lance.mdx +5 -6
- package/.docs/raw/reference/vectors/libsql.mdx +1 -1
- package/.docs/raw/reference/vectors/mongodb.mdx +1 -1
- package/.docs/raw/reference/vectors/opensearch.mdx +1 -1
- package/.docs/raw/reference/vectors/pg.mdx +8 -4
- package/.docs/raw/reference/vectors/pinecone.mdx +1 -1
- package/.docs/raw/reference/vectors/qdrant.mdx +1 -1
- package/.docs/raw/reference/vectors/s3vectors.mdx +35 -27
- package/.docs/raw/reference/vectors/turbopuffer.mdx +1 -1
- package/.docs/raw/reference/vectors/upstash.mdx +33 -25
- package/.docs/raw/reference/vectors/vectorize.mdx +1 -1
- package/.docs/raw/reference/voice/azure.mdx +1 -1
- package/.docs/raw/reference/voice/cloudflare.mdx +1 -1
- package/.docs/raw/reference/voice/composite-voice.mdx +1 -1
- package/.docs/raw/reference/voice/deepgram.mdx +1 -1
- package/.docs/raw/reference/voice/elevenlabs.mdx +1 -1
- package/.docs/raw/reference/voice/google-gemini-live.mdx +6 -4
- package/.docs/raw/reference/voice/google.mdx +1 -1
- package/.docs/raw/reference/voice/mastra-voice.mdx +1 -1
- package/.docs/raw/reference/voice/murf.mdx +1 -1
- package/.docs/raw/reference/voice/openai-realtime.mdx +1 -1
- package/.docs/raw/reference/voice/openai.mdx +1 -1
- package/.docs/raw/reference/voice/playai.mdx +1 -1
- package/.docs/raw/reference/voice/sarvam.mdx +1 -1
- package/.docs/raw/reference/voice/speechify.mdx +1 -1
- package/.docs/raw/reference/voice/voice.addInstructions.mdx +1 -1
- package/.docs/raw/reference/voice/voice.addTools.mdx +1 -1
- package/.docs/raw/reference/voice/voice.answer.mdx +1 -1
- package/.docs/raw/reference/voice/voice.close.mdx +1 -1
- package/.docs/raw/reference/voice/voice.connect.mdx +1 -1
- package/.docs/raw/reference/voice/voice.events.mdx +1 -1
- package/.docs/raw/reference/voice/voice.getSpeakers.mdx +23 -30
- package/.docs/raw/reference/voice/voice.listen.mdx +1 -1
- package/.docs/raw/reference/voice/voice.off.mdx +1 -1
- package/.docs/raw/reference/voice/voice.on.mdx +1 -1
- package/.docs/raw/reference/voice/voice.send.mdx +1 -1
- package/.docs/raw/reference/voice/voice.speak.mdx +1 -1
- package/.docs/raw/reference/voice/voice.updateConfig.mdx +1 -1
- package/.docs/raw/reference/workflows/run-methods/cancel.mdx +4 -3
- package/.docs/raw/reference/workflows/run-methods/resume.mdx +49 -34
- package/.docs/raw/reference/workflows/run-methods/start.mdx +43 -31
- package/.docs/raw/reference/workflows/run-methods/watch.mdx +7 -8
- package/.docs/raw/reference/workflows/run.mdx +7 -10
- package/.docs/raw/reference/workflows/step.mdx +15 -12
- 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 -7
- package/.docs/raw/reference/workflows/workflow-methods/dountil.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/dowhile.mdx +2 -2
- package/.docs/raw/reference/workflows/workflow-methods/foreach.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/map.mdx +3 -2
- package/.docs/raw/reference/workflows/workflow-methods/parallel.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/sendEvent.mdx +5 -5
- package/.docs/raw/reference/workflows/workflow-methods/sleep.mdx +3 -2
- package/.docs/raw/reference/workflows/workflow-methods/sleepUntil.mdx +3 -2
- package/.docs/raw/reference/workflows/workflow-methods/then.mdx +1 -1
- package/.docs/raw/reference/workflows/workflow-methods/waitForEvent.mdx +3 -3
- package/.docs/raw/reference/workflows/workflow.mdx +13 -10
- package/.docs/raw/scorers/custom-scorers.mdx +58 -48
- package/.docs/raw/scorers/evals-old-api/custom-eval.mdx +6 -8
- package/.docs/raw/scorers/evals-old-api/overview.mdx +8 -8
- package/.docs/raw/scorers/evals-old-api/running-in-ci.mdx +9 -9
- package/.docs/raw/scorers/evals-old-api/textual-evals.mdx +5 -5
- package/.docs/raw/scorers/off-the-shelf-scorers.mdx +3 -1
- package/.docs/raw/scorers/overview.mdx +20 -19
- package/.docs/raw/server-db/custom-api-routes.mdx +8 -8
- package/.docs/raw/server-db/mastra-client.mdx +56 -54
- package/.docs/raw/server-db/middleware.mdx +11 -7
- package/.docs/raw/server-db/production-server.mdx +5 -7
- package/.docs/raw/server-db/runtime-context.mdx +41 -38
- package/.docs/raw/server-db/storage.mdx +82 -87
- package/.docs/raw/streaming/events.mdx +24 -16
- package/.docs/raw/streaming/overview.mdx +17 -18
- package/.docs/raw/streaming/tool-streaming.mdx +9 -10
- package/.docs/raw/streaming/workflow-streaming.mdx +14 -12
- package/.docs/raw/tools-mcp/advanced-usage.mdx +2 -2
- package/.docs/raw/tools-mcp/mcp-overview.mdx +92 -102
- package/.docs/raw/tools-mcp/overview.mdx +9 -14
- package/.docs/raw/voice/overview.mdx +273 -250
- package/.docs/raw/voice/speech-to-speech.mdx +14 -12
- package/.docs/raw/voice/speech-to-text.mdx +2 -2
- package/.docs/raw/voice/text-to-speech.mdx +2 -2
- package/.docs/raw/workflows/agents-and-tools.mdx +29 -28
- package/.docs/raw/workflows/control-flow.mdx +24 -24
- package/.docs/raw/workflows/error-handling.mdx +15 -17
- package/.docs/raw/workflows/human-in-the-loop.mdx +39 -39
- package/.docs/raw/workflows/inngest-workflow.mdx +33 -29
- package/.docs/raw/workflows/input-data-mapping.mdx +9 -9
- package/.docs/raw/workflows/overview.mdx +60 -60
- package/.docs/raw/workflows/snapshots.mdx +54 -36
- package/.docs/raw/workflows/suspend-and-resume.mdx +52 -57
- package/.docs/raw/workflows-legacy/control-flow.mdx +15 -17
- package/.docs/raw/workflows-legacy/dynamic-workflows.mdx +3 -1
- package/.docs/raw/workflows-legacy/error-handling.mdx +8 -6
- package/.docs/raw/workflows-legacy/nested-workflows.mdx +6 -0
- package/.docs/raw/workflows-legacy/overview.mdx +28 -26
- package/.docs/raw/workflows-legacy/runtime-variables.mdx +4 -2
- package/.docs/raw/workflows-legacy/steps.mdx +5 -3
- package/.docs/raw/workflows-legacy/suspend-and-resume.mdx +10 -8
- package/.docs/raw/workflows-legacy/variables.mdx +10 -8
- package/CHANGELOG.md +14 -0
- package/package.json +5 -5
- package/.docs/raw/memory/storage/memory-with-mongodb.mdx +0 -148
|
@@ -3,8 +3,6 @@ title: "Sensitive Data Filter | Processors | Observability | Mastra Docs"
|
|
|
3
3
|
description: "Protect sensitive information in your AI traces with automatic data redaction"
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { Callout } from "nextra/components";
|
|
7
|
-
|
|
8
6
|
# Sensitive Data Filter
|
|
9
7
|
|
|
10
8
|
The Sensitive Data Filter is a span processor that automatically redacts sensitive information from your AI traces before they're exported. This ensures that passwords, API keys, tokens, and other confidential data never leave your application or get stored in observability platforms.
|
|
@@ -13,7 +11,7 @@ The Sensitive Data Filter is a span processor that automatically redacts sensiti
|
|
|
13
11
|
|
|
14
12
|
By default, the Sensitive Data Filter is automatically enabled when you use the standard Mastra configuration:
|
|
15
13
|
|
|
16
|
-
```ts
|
|
14
|
+
```ts title="src/mastra/index.ts" showLineNumbers copy
|
|
17
15
|
export const mastra = new Mastra({
|
|
18
16
|
observability: {
|
|
19
17
|
default: { enabled: true }, // Automatically includes SensitiveDataFilter
|
|
@@ -42,9 +40,11 @@ With the default configuration, the filter automatically redacts these common se
|
|
|
42
40
|
- `refresh`
|
|
43
41
|
- `ssn`
|
|
44
42
|
|
|
45
|
-
|
|
43
|
+
:::note
|
|
44
|
+
|
|
46
45
|
Field matching is case-insensitive and normalizes separators. For example, `api-key`, `api_key`, and `Api Key` are all treated as `apikey`.
|
|
47
|
-
|
|
46
|
+
|
|
47
|
+
:::
|
|
48
48
|
|
|
49
49
|
## How It Works
|
|
50
50
|
|
|
@@ -62,30 +62,38 @@ When a sensitive field is detected, its value is replaced with `[REDACTED]` by d
|
|
|
62
62
|
|
|
63
63
|
You can customize which fields are redacted and how redaction appears:
|
|
64
64
|
|
|
65
|
-
```ts
|
|
66
|
-
import { SensitiveDataFilter, DefaultExporter } from
|
|
65
|
+
```ts title="src/mastra/index.ts" showLineNumbers copy
|
|
66
|
+
import { SensitiveDataFilter, DefaultExporter } from "@mastra/core/ai-tracing";
|
|
67
67
|
|
|
68
68
|
export const mastra = new Mastra({
|
|
69
69
|
observability: {
|
|
70
70
|
configs: {
|
|
71
71
|
production: {
|
|
72
|
-
serviceName:
|
|
72
|
+
serviceName: "my-service",
|
|
73
73
|
exporters: [new DefaultExporter()],
|
|
74
74
|
processors: [
|
|
75
75
|
new SensitiveDataFilter({
|
|
76
76
|
// Add custom sensitive fields
|
|
77
77
|
sensitiveFields: [
|
|
78
78
|
// Default fields
|
|
79
|
-
|
|
79
|
+
"password",
|
|
80
|
+
"token",
|
|
81
|
+
"secret",
|
|
82
|
+
"key",
|
|
83
|
+
"apikey",
|
|
80
84
|
// Custom fields for your application
|
|
81
|
-
|
|
82
|
-
|
|
85
|
+
"creditCard",
|
|
86
|
+
"bankAccount",
|
|
87
|
+
"routingNumber",
|
|
88
|
+
"email",
|
|
89
|
+
"phoneNumber",
|
|
90
|
+
"dateOfBirth",
|
|
83
91
|
],
|
|
84
92
|
// Custom redaction token
|
|
85
|
-
redactionToken:
|
|
93
|
+
redactionToken: "***SENSITIVE***",
|
|
86
94
|
// Redaction style
|
|
87
|
-
redactionStyle:
|
|
88
|
-
})
|
|
95
|
+
redactionStyle: "full", // or 'partial'
|
|
96
|
+
}),
|
|
89
97
|
],
|
|
90
98
|
},
|
|
91
99
|
},
|
|
@@ -121,8 +129,8 @@ Shows the first and last 3 characters, useful for debugging without exposing ful
|
|
|
121
129
|
|
|
122
130
|
```ts
|
|
123
131
|
new SensitiveDataFilter({
|
|
124
|
-
redactionStyle:
|
|
125
|
-
})
|
|
132
|
+
redactionStyle: "partial",
|
|
133
|
+
});
|
|
126
134
|
```
|
|
127
135
|
|
|
128
136
|
```json
|
|
@@ -201,12 +209,12 @@ The Sensitive Data Filter is designed to be lightweight and efficient:
|
|
|
201
209
|
|
|
202
210
|
If you need to disable sensitive data filtering (not recommended for production):
|
|
203
211
|
|
|
204
|
-
```ts
|
|
212
|
+
```ts title="src/mastra/index.ts" showLineNumbers copy
|
|
205
213
|
export const mastra = new Mastra({
|
|
206
214
|
observability: {
|
|
207
215
|
configs: {
|
|
208
216
|
debug: {
|
|
209
|
-
serviceName:
|
|
217
|
+
serviceName: "debug-service",
|
|
210
218
|
processors: [], // No processors, including no SensitiveDataFilter
|
|
211
219
|
exporters: [new DefaultExporter()],
|
|
212
220
|
},
|
|
@@ -215,9 +223,11 @@ export const mastra = new Mastra({
|
|
|
215
223
|
});
|
|
216
224
|
```
|
|
217
225
|
|
|
218
|
-
|
|
226
|
+
:::warning
|
|
227
|
+
|
|
219
228
|
Only disable sensitive data filtering in controlled environments. Never disable it when sending traces to external services or shared storage.
|
|
220
|
-
|
|
229
|
+
|
|
230
|
+
:::
|
|
221
231
|
|
|
222
232
|
## Common Use Cases
|
|
223
233
|
|
|
@@ -227,13 +237,17 @@ Only disable sensitive data filtering in controlled environments. Never disable
|
|
|
227
237
|
new SensitiveDataFilter({
|
|
228
238
|
sensitiveFields: [
|
|
229
239
|
// HIPAA-related fields
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
240
|
+
"ssn",
|
|
241
|
+
"socialSecurityNumber",
|
|
242
|
+
"medicalRecordNumber",
|
|
243
|
+
"mrn",
|
|
244
|
+
"healthInsuranceNumber",
|
|
245
|
+
"diagnosisCode",
|
|
246
|
+
"icd10",
|
|
247
|
+
"prescription",
|
|
248
|
+
"medication",
|
|
249
|
+
],
|
|
250
|
+
});
|
|
237
251
|
```
|
|
238
252
|
|
|
239
253
|
### Financial Services
|
|
@@ -242,13 +256,21 @@ new SensitiveDataFilter({
|
|
|
242
256
|
new SensitiveDataFilter({
|
|
243
257
|
sensitiveFields: [
|
|
244
258
|
// PCI compliance fields
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
259
|
+
"creditCard",
|
|
260
|
+
"ccNumber",
|
|
261
|
+
"cardNumber",
|
|
262
|
+
"cvv",
|
|
263
|
+
"cvc",
|
|
264
|
+
"securityCode",
|
|
265
|
+
"expirationDate",
|
|
266
|
+
"expiry",
|
|
267
|
+
"bankAccount",
|
|
268
|
+
"accountNumber",
|
|
269
|
+
"routingNumber",
|
|
270
|
+
"iban",
|
|
271
|
+
"swift",
|
|
272
|
+
],
|
|
273
|
+
});
|
|
252
274
|
```
|
|
253
275
|
|
|
254
276
|
## Error Handling
|
|
@@ -270,5 +292,4 @@ This ensures that processing errors don't prevent traces from being exported or
|
|
|
270
292
|
## Related
|
|
271
293
|
|
|
272
294
|
- [SensitiveDataFilter API](/reference/observability/ai-tracing/processors/sensitive-data-filter)
|
|
273
|
-
- [Basic AI Tracing Example](/examples/observability/basic-ai-tracing)
|
|
274
|
-
|
|
295
|
+
- [Basic AI Tracing Example](/examples/observability/basic-ai-tracing)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Logging | Mastra
|
|
2
|
+
title: "Logging | Observability | Mastra Docs"
|
|
3
3
|
description: Learn how to use logging in Mastra to monitor execution, capture application behavior, and improve the accuracy of AI applications.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -7,26 +7,26 @@ description: Learn how to use logging in Mastra to monitor execution, capture ap
|
|
|
7
7
|
|
|
8
8
|
Mastra's logging system captures function execution, input data, and output responses in a structured format.
|
|
9
9
|
|
|
10
|
-
When deploying to Mastra Cloud, logs are shown on the [Logs](../mastra-cloud/observability
|
|
10
|
+
When deploying to Mastra Cloud, logs are shown on the [Logs](../mastra-cloud/observability) page. In self-hosted or custom environments, logs can be directed to files or external services depending on the configured transports.
|
|
11
11
|
|
|
12
12
|
## PinoLogger
|
|
13
13
|
|
|
14
|
-
When [initializing a new Mastra project](../getting-started/installation
|
|
14
|
+
When [initializing a new Mastra project](../getting-started/installation) using the CLI, `PinoLogger` is included by default.
|
|
15
15
|
|
|
16
|
-
```typescript
|
|
17
|
-
import { Mastra } from
|
|
18
|
-
import { PinoLogger } from
|
|
16
|
+
```typescript title="src/mastra/index.ts" showLineNumbers copy
|
|
17
|
+
import { Mastra } from "@mastra/core/mastra";
|
|
18
|
+
import { PinoLogger } from "@mastra/loggers";
|
|
19
19
|
|
|
20
20
|
export const mastra = new Mastra({
|
|
21
21
|
// ...
|
|
22
22
|
logger: new PinoLogger({
|
|
23
|
-
name:
|
|
24
|
-
level:
|
|
23
|
+
name: "Mastra",
|
|
24
|
+
level: "info",
|
|
25
25
|
}),
|
|
26
26
|
});
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
> See the [PinoLogger](
|
|
29
|
+
> See the [PinoLogger](/reference/observability/logging/pino-logger) API reference for all available configuration options.
|
|
30
30
|
|
|
31
31
|
## Logging from workflows and tools
|
|
32
32
|
|
|
@@ -36,8 +36,7 @@ Mastra provides access to a logger instance via the `mastra.getLogger()` method,
|
|
|
36
36
|
|
|
37
37
|
Within a workflow step, access the logger via the `mastra` parameter inside the `execute` function. This allows you to log messages relevant to the step’s execution.
|
|
38
38
|
|
|
39
|
-
|
|
40
|
-
```typescript {8-9} filename="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
|
|
39
|
+
```typescript {8-9} title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
|
|
41
40
|
import { createWorkflow, createStep } from "@mastra/core/workflows";
|
|
42
41
|
import { z } from "zod";
|
|
43
42
|
|
|
@@ -63,32 +62,30 @@ export const testWorkflow = createWorkflow({...})
|
|
|
63
62
|
|
|
64
63
|
Similarly, tools have access to the logger instance via the `mastra` parameter. Use this to log tool specific activity during execution.
|
|
65
64
|
|
|
66
|
-
```typescript {8-9}
|
|
65
|
+
```typescript {8-9} title="src/mastra/tools/test-tool.ts" showLineNumbers copy
|
|
67
66
|
import { createTool } from "@mastra/core/tools";
|
|
68
67
|
import { z } from "zod";
|
|
69
68
|
|
|
70
69
|
export const testTool = createTool({
|
|
71
70
|
// ...
|
|
72
71
|
execute: async ({ mastra }) => {
|
|
73
|
-
|
|
74
72
|
const logger = mastra?.getLogger();
|
|
75
73
|
logger?.info("tool info log");
|
|
76
74
|
|
|
77
75
|
return {
|
|
78
|
-
output: ""
|
|
76
|
+
output: "",
|
|
79
77
|
};
|
|
80
|
-
}
|
|
78
|
+
},
|
|
81
79
|
});
|
|
82
80
|
```
|
|
83
81
|
|
|
84
|
-
|
|
85
82
|
## Logging with additional data
|
|
86
83
|
|
|
87
84
|
Logger methods accept an optional second argument for additional data. This can be any value, such as an object, string, or number.
|
|
88
85
|
|
|
89
86
|
In this example, the log message includes an object with a key of `agent` and a value of the `testAgent` instance.
|
|
90
87
|
|
|
91
|
-
```typescript {11}
|
|
88
|
+
```typescript {11} title="src/mastra/workflows/test-workflow.ts" showLineNumbers copy
|
|
92
89
|
import { createWorkflow, createStep } from "@mastra/core/workflows";
|
|
93
90
|
import { z } from "zod";
|
|
94
91
|
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Next.js Tracing | Mastra
|
|
2
|
+
title: "Next.js Tracing | Observability | Mastra Docs"
|
|
3
3
|
description: "Set up OpenTelemetry tracing for Next.js applications"
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -11,7 +11,7 @@ Next.js requires additional configuration to enable OpenTelemetry tracing.
|
|
|
11
11
|
|
|
12
12
|
Start by enabling the instrumentation hook in your Next.js config:
|
|
13
13
|
|
|
14
|
-
```ts
|
|
14
|
+
```ts title="next.config.ts" showLineNumbers copy
|
|
15
15
|
import type { NextConfig } from "next";
|
|
16
16
|
|
|
17
17
|
const nextConfig: NextConfig = {
|
|
@@ -27,7 +27,7 @@ export default nextConfig;
|
|
|
27
27
|
|
|
28
28
|
Configure your Mastra instance:
|
|
29
29
|
|
|
30
|
-
```typescript
|
|
30
|
+
```typescript title="mastra.config.ts" copy
|
|
31
31
|
import { Mastra } from "@mastra/core";
|
|
32
32
|
|
|
33
33
|
export const mastra = new Mastra({
|
|
@@ -55,7 +55,7 @@ npm install @opentelemetry/api langfuse-vercel
|
|
|
55
55
|
|
|
56
56
|
2. Create an instrumentation file:
|
|
57
57
|
|
|
58
|
-
```ts
|
|
58
|
+
```ts title="instrumentation.ts" copy
|
|
59
59
|
import {
|
|
60
60
|
NodeSDK,
|
|
61
61
|
ATTR_SERVICE_NAME,
|
|
@@ -91,7 +91,7 @@ npm install @opentelemetry/api @vercel/otel
|
|
|
91
91
|
|
|
92
92
|
2. Create an instrumentation file at the root of your project (or in the src folder if using one):
|
|
93
93
|
|
|
94
|
-
```ts
|
|
94
|
+
```ts title="instrumentation.ts" copy
|
|
95
95
|
import { registerOTel } from "@vercel/otel";
|
|
96
96
|
|
|
97
97
|
export function register() {
|
|
@@ -1,10 +1,8 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "OTEL Tracing | Mastra
|
|
2
|
+
title: "OTEL Tracing | Observability | Mastra Docs"
|
|
3
3
|
description: "Set up OpenTelemetry tracing for Mastra applications"
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import Image from "next/image";
|
|
7
|
-
|
|
8
6
|
# OTEL Tracing
|
|
9
7
|
|
|
10
8
|
Mastra supports the OpenTelemetry Protocol (OTLP) for tracing and monitoring your application. When telemetry is enabled, Mastra automatically traces all core primitives including agent operations, LLM interactions, tool executions, integration calls, workflow runs, and database operations. Your telemetry data can then be exported to any OTEL collector.
|
|
@@ -13,7 +11,7 @@ Mastra supports the OpenTelemetry Protocol (OTLP) for tracing and monitoring you
|
|
|
13
11
|
|
|
14
12
|
Here's a simple example of enabling telemetry:
|
|
15
13
|
|
|
16
|
-
```ts
|
|
14
|
+
```ts title="mastra.config.ts" showLineNumbers copy
|
|
17
15
|
export const mastra = new Mastra({
|
|
18
16
|
// ... other config
|
|
19
17
|
telemetry: {
|
|
@@ -60,20 +58,20 @@ type OtelConfig = {
|
|
|
60
58
|
};
|
|
61
59
|
```
|
|
62
60
|
|
|
63
|
-
See the
|
|
61
|
+
See the inline type definition above for more details.
|
|
64
62
|
|
|
65
63
|
### Environment Variables
|
|
66
64
|
|
|
67
65
|
You can configure the OTLP endpoint and headers through environment variables:
|
|
68
66
|
|
|
69
|
-
```env
|
|
67
|
+
```env title=".env" copy
|
|
70
68
|
OTEL_EXPORTER_OTLP_ENDPOINT=http://localhost:4318
|
|
71
69
|
OTEL_EXPORTER_OTLP_HEADERS=x-api-key=your-api-key
|
|
72
70
|
```
|
|
73
71
|
|
|
74
72
|
Then in your config:
|
|
75
73
|
|
|
76
|
-
```ts
|
|
74
|
+
```ts title="mastra.config.ts" showLineNumbers copy
|
|
77
75
|
export const mastra = new Mastra({
|
|
78
76
|
// ... other config
|
|
79
77
|
telemetry: {
|
|
@@ -92,7 +90,7 @@ export const mastra = new Mastra({
|
|
|
92
90
|
Here's what a traced agent interaction looks like in [SigNoz](https://signoz.io):
|
|
93
91
|
|
|
94
92
|
<img
|
|
95
|
-
src="/
|
|
93
|
+
src="/img/signoz-telemetry-demo.png"
|
|
96
94
|
alt="Agent interaction trace showing spans, LLM calls, and tool executions"
|
|
97
95
|
style={{ maxWidth: "800px", width: "100%", margin: "8px 0" }}
|
|
98
96
|
className="nextra-image rounded-md"
|
|
@@ -103,7 +101,7 @@ Here's what a traced agent interaction looks like in [SigNoz](https://signoz.io)
|
|
|
103
101
|
|
|
104
102
|
### Other Supported Providers
|
|
105
103
|
|
|
106
|
-
|
|
104
|
+
Mastra supports any OTLP-compatible observability platform including Datadog, New Relic, Jaeger, and others. Configure them using the same OTLP endpoint pattern shown above.
|
|
107
105
|
|
|
108
106
|
### Custom Instrumentation files
|
|
109
107
|
|
|
@@ -112,20 +110,21 @@ You can define custom instrumentation files in your Mastra project by placing th
|
|
|
112
110
|
#### Supported File Types
|
|
113
111
|
|
|
114
112
|
Mastra looks for instrumentation files with these extensions:
|
|
113
|
+
|
|
115
114
|
- `instrumentation.js`
|
|
116
|
-
- `instrumentation.ts`
|
|
115
|
+
- `instrumentation.ts`
|
|
117
116
|
- `instrumentation.mjs`
|
|
118
117
|
|
|
119
118
|
#### Example
|
|
120
119
|
|
|
121
|
-
```ts
|
|
122
|
-
import { NodeSDK } from
|
|
123
|
-
import { getNodeAutoInstrumentations } from
|
|
124
|
-
import { OTLPTraceExporter } from
|
|
120
|
+
```ts title="/mastra/instrumentation.ts" showLineNumbers copy
|
|
121
|
+
import { NodeSDK } from "@opentelemetry/sdk-node";
|
|
122
|
+
import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
|
|
123
|
+
import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
|
|
125
124
|
|
|
126
125
|
const sdk = new NodeSDK({
|
|
127
126
|
traceExporter: new OTLPTraceExporter({
|
|
128
|
-
url:
|
|
127
|
+
url: "http://localhost:4318/v1/traces",
|
|
129
128
|
}),
|
|
130
129
|
instrumentations: [getNodeAutoInstrumentations()],
|
|
131
130
|
});
|
|
@@ -154,9 +153,9 @@ export const mastra = new Mastra({
|
|
|
154
153
|
2. Create an instrumentation file in your project (e.g., `instrumentation.mjs`):
|
|
155
154
|
|
|
156
155
|
```typescript
|
|
157
|
-
import { NodeSDK } from
|
|
158
|
-
import { getNodeAutoInstrumentations } from
|
|
159
|
-
import { OTLPTraceExporter } from
|
|
156
|
+
import { NodeSDK } from "@opentelemetry/sdk-node";
|
|
157
|
+
import { getNodeAutoInstrumentations } from "@opentelemetry/auto-instrumentations-node";
|
|
158
|
+
import { OTLPTraceExporter } from "@opentelemetry/exporter-trace-otlp-http";
|
|
160
159
|
|
|
161
160
|
const sdk = new NodeSDK({
|
|
162
161
|
traceExporter: new OTLPTraceExporter(),
|
|
@@ -1,10 +1,8 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: "Overview | Observability | Mastra Docs"
|
|
2
|
+
title: "Observability Overview | Observability | Mastra Docs"
|
|
3
3
|
description: Monitor and debug applications with Mastra's Observability features.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
import { Callout } from "nextra/components";
|
|
7
|
-
|
|
8
6
|
# Observability Overview
|
|
9
7
|
|
|
10
8
|
Mastra provides comprehensive observability features designed specifically for AI applications. Monitor LLM operations, trace agent decisions, and debug complex workflows with specialized tools that understand AI-specific patterns.
|
|
@@ -12,19 +10,25 @@ Mastra provides comprehensive observability features designed specifically for A
|
|
|
12
10
|
## Key Features
|
|
13
11
|
|
|
14
12
|
### Structured Logging
|
|
13
|
+
|
|
15
14
|
Debug applications with contextual logging:
|
|
15
|
+
|
|
16
16
|
- **Context propagation**: Automatic correlation with traces
|
|
17
17
|
- **Configurable levels**: Filter by severity in development and production
|
|
18
18
|
|
|
19
19
|
### AI Tracing
|
|
20
|
+
|
|
20
21
|
Specialized tracing for AI operations that captures:
|
|
22
|
+
|
|
21
23
|
- **LLM interactions**: Token usage, latency, prompts, and completions
|
|
22
24
|
- **Agent execution**: Decision paths, tool calls, and memory operations
|
|
23
25
|
- **Workflow steps**: Branching logic, parallel execution, and step outputs
|
|
24
26
|
- **Automatic instrumentation**: Zero-configuration tracing with decorators
|
|
25
27
|
|
|
26
28
|
### OTEL Tracing
|
|
29
|
+
|
|
27
30
|
Traditional distributed tracing with OpenTelemetry:
|
|
31
|
+
|
|
28
32
|
- **Standard OTLP protocol**: Compatible with existing observability infrastructure
|
|
29
33
|
- **HTTP and database instrumentation**: Automatic spans for common operations
|
|
30
34
|
- **Provider integrations**: Datadog, New Relic, Jaeger, and other OTLP collectors
|
|
@@ -34,7 +38,7 @@ Traditional distributed tracing with OpenTelemetry:
|
|
|
34
38
|
|
|
35
39
|
Configure Observability in your Mastra instance:
|
|
36
40
|
|
|
37
|
-
```typescript
|
|
41
|
+
```typescript title="src/mastra/index.ts"
|
|
38
42
|
import { Mastra } from "@mastra/core";
|
|
39
43
|
import { PinoLogger } from "@mastra/core";
|
|
40
44
|
import { LibSqlStorage } from "@mastra/libsql";
|
|
@@ -50,17 +54,17 @@ export const mastra = new Mastra({
|
|
|
50
54
|
}),
|
|
51
55
|
telemetry: {
|
|
52
56
|
enabled: true, // Enables OTEL Tracing
|
|
53
|
-
}
|
|
57
|
+
},
|
|
54
58
|
});
|
|
55
59
|
```
|
|
56
60
|
|
|
57
61
|
With this basic setup, you will see Traces and Logs in both the Playground and in Mastra Cloud.
|
|
58
62
|
|
|
59
|
-
We also support various external tracing providers like Langfuse, Braintrust, and any OpenTelemetry-compatible platform (Datadog, New Relic, SigNoz, etc.). See more about this in the [AI Tracing](/docs/observability/ai-tracing
|
|
63
|
+
We also support various external tracing providers like Langfuse, Braintrust, and any OpenTelemetry-compatible platform (Datadog, New Relic, SigNoz, etc.). See more about this in the [AI Tracing](/docs/observability/ai-tracing/overview) documentation.
|
|
60
64
|
|
|
61
65
|
## What's Next?
|
|
62
66
|
|
|
63
|
-
- **[Set up AI Tracing](/docs/observability/ai-tracing
|
|
64
|
-
- **[Configure Logging](/docs/observability/logging
|
|
65
|
-
- **[View Examples](/examples/observability/basic-ai-tracing
|
|
66
|
-
- **[API Reference](/reference/observability/ai-tracing/
|
|
67
|
+
- **[Set up AI Tracing](/docs/observability/ai-tracing/overview)**: Configure tracing for your application
|
|
68
|
+
- **[Configure Logging](/docs/observability/logging)**: Add structured logging
|
|
69
|
+
- **[View Examples](/examples/observability/basic-ai-tracing)**: See observability in action
|
|
70
|
+
- **[API Reference](/reference/observability/ai-tracing/)**: Detailed configuration options
|
|
@@ -3,7 +3,7 @@ title: Chunking and Embedding Documents | RAG | Mastra Docs
|
|
|
3
3
|
description: Guide on chunking and embedding documents in Mastra for efficient processing and retrieval.
|
|
4
4
|
---
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
# Chunking and Embedding Documents
|
|
7
7
|
|
|
8
8
|
Before processing, create a MDocument instance from your content. You can initialize it from various formats:
|
|
9
9
|
|
|
@@ -69,7 +69,7 @@ const chunks = await doc.chunk({
|
|
|
69
69
|
|
|
70
70
|
**Note:** Metadata extraction may use LLM calls, so ensure your API key is set.
|
|
71
71
|
|
|
72
|
-
We go deeper into chunking strategies in our [chunk documentation](/reference/rag/chunk
|
|
72
|
+
We go deeper into chunking strategies in our [chunk documentation](/reference/rag/chunk).
|
|
73
73
|
|
|
74
74
|
## Step 2: Embedding Generation
|
|
75
75
|
|
|
@@ -83,7 +83,9 @@ The simplest way is to use Mastra's model router with `provider/model` strings:
|
|
|
83
83
|
import { ModelRouterEmbeddingModel } from "@mastra/core";
|
|
84
84
|
import { embedMany } from "ai";
|
|
85
85
|
|
|
86
|
-
const embeddingModel = new ModelRouterEmbeddingModel(
|
|
86
|
+
const embeddingModel = new ModelRouterEmbeddingModel(
|
|
87
|
+
"openai/text-embedding-3-small",
|
|
88
|
+
);
|
|
87
89
|
|
|
88
90
|
const { embeddings } = await embedMany({
|
|
89
91
|
model: embeddingModel,
|
|
@@ -92,6 +94,7 @@ const { embeddings } = await embedMany({
|
|
|
92
94
|
```
|
|
93
95
|
|
|
94
96
|
Supported embedding models:
|
|
97
|
+
|
|
95
98
|
- **OpenAI**: `text-embedding-3-small`, `text-embedding-3-large`, `text-embedding-ada-002`
|
|
96
99
|
- **Google**: `gemini-embedding-001`, `text-embedding-004`
|
|
97
100
|
|
|
@@ -198,11 +201,10 @@ await vectorStore.upsert({
|
|
|
198
201
|
|
|
199
202
|
For more examples of different chunking strategies and embedding configurations, see:
|
|
200
203
|
|
|
201
|
-
- [
|
|
202
|
-
- [
|
|
203
|
-
- [Embed Text with Cohere](/reference/rag/embeddings.mdx#using-cohere)
|
|
204
|
+
- [Chunk Reference](/reference/rag/chunk)
|
|
205
|
+
- [Embeddings Reference](/reference/rag/embeddings)
|
|
204
206
|
|
|
205
207
|
For more details on vector databases and embeddings, see:
|
|
206
208
|
|
|
207
|
-
- [Vector Databases](./vector-databases
|
|
208
|
-
- [Embedding API Reference](/reference/rag/embeddings
|
|
209
|
+
- [Vector Databases](./vector-databases)
|
|
210
|
+
- [Embedding API Reference](/reference/rag/embeddings)
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
---
|
|
2
|
-
title: RAG (Retrieval-Augmented Generation) in Mastra | Mastra Docs
|
|
2
|
+
title: "RAG (Retrieval-Augmented Generation) in Mastra | RAG | Mastra Docs"
|
|
3
3
|
description: Overview of Retrieval-Augmented Generation (RAG) in Mastra, detailing its capabilities for enhancing LLM outputs with relevant context.
|
|
4
4
|
---
|
|
5
5
|
|
|
@@ -64,11 +64,11 @@ This example shows the essentials: initialize a document, create chunks, generat
|
|
|
64
64
|
|
|
65
65
|
## Document Processing
|
|
66
66
|
|
|
67
|
-
The basic building block of RAG is document processing. Documents can be chunked using various strategies (recursive, sliding window, etc.) and enriched with metadata. See the [chunking and embedding doc](./chunking-and-embedding
|
|
67
|
+
The basic building block of RAG is document processing. Documents can be chunked using various strategies (recursive, sliding window, etc.) and enriched with metadata. See the [chunking and embedding doc](./chunking-and-embedding).
|
|
68
68
|
|
|
69
69
|
## Vector Storage
|
|
70
70
|
|
|
71
|
-
Mastra supports multiple vector stores for embedding persistence and similarity search, including pgvector, Pinecone, Qdrant, and MongoDB. See the [vector database doc](./vector-databases
|
|
71
|
+
Mastra supports multiple vector stores for embedding persistence and similarity search, including pgvector, Pinecone, Qdrant, and MongoDB. See the [vector database doc](./vector-databases).
|
|
72
72
|
|
|
73
73
|
## Observability and Debugging
|
|
74
74
|
|
|
@@ -79,9 +79,9 @@ Mastra's RAG system includes observability features to help you optimize your re
|
|
|
79
79
|
- Analyze query patterns and cache hit rates
|
|
80
80
|
- Export metrics to your observability platform
|
|
81
81
|
|
|
82
|
-
See the [
|
|
82
|
+
See the [OTEL Tracing](/docs/observability/otel-tracing) documentation for more details.
|
|
83
83
|
|
|
84
84
|
## More resources
|
|
85
85
|
|
|
86
|
-
- [Chain of Thought RAG Example](
|
|
86
|
+
- [Chain of Thought RAG Example](/examples/rag/usage/cot-rag)
|
|
87
87
|
- [All RAG Examples](../../examples/) (including different chunking strategies, embedding models, and vector stores)
|