doc: Add MLflow observability integration guide#1114
Conversation
Signed-off-by: B-Step62 <yuki.watanabe@databricks.com>
|
📝 WalkthroughWalkthroughAdds a new documentation file for MLflow integration under the observability section, explaining how to export VoltAgent traces to MLflow via OpenTelemetry OTLP exporter. Updates the sidebar navigation to reference the new documentation. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~8 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Tip Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs). Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
website/docs/observability/mlflow.md (1)
89-91: Optional: vary link text in “Learn More” for better scanability.All three bullets start with “MLflow”; slight wording variation would improve readability.
Suggested wording tweak
- - [MLflow Tracing](https://mlflow.org/docs/latest/genai/tracing/index.html) — Full tracing guide including evaluation, prompt management, and more. - - [MLflow OpenTelemetry Integration](https://mlflow.org/docs/latest/genai/tracing/opentelemetry.html) — Details on MLflow's OpenTelemetry support. - - [MLflow VoltAgent Guide](https://mlflow.org/docs/latest/genai/tracing/integrations/listing/voltagent.html) — Step-by-step setup tutorial with screenshots. + - [MLflow Tracing](https://mlflow.org/docs/latest/genai/tracing/index.html) — Full tracing guide including evaluation, prompt management, and more. + - [OpenTelemetry Integration in MLflow](https://mlflow.org/docs/latest/genai/tracing/opentelemetry.html) — Details on MLflow's OpenTelemetry support. + - [VoltAgent Guide on MLflow](https://mlflow.org/docs/latest/genai/tracing/integrations/listing/voltagent.html) — Step-by-step setup tutorial with screenshots.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@website/docs/observability/mlflow.md` around lines 89 - 91, Vary the three bullet link texts to improve scanability by rewording each prefix: change "[MLflow Tracing]" to something like "Tracing with MLflow" (for the tracing guide), "[MLflow OpenTelemetry Integration]" to "OpenTelemetry in MLflow" (for the OpenTelemetry support page), and "[MLflow VoltAgent Guide]" to "VoltAgent setup (MLflow)" or "Setting up VoltAgent" (for the VoltAgent tutorial); update the displayed link labels in the three list items so they differ while keeping the same URLs.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@website/docs/observability/mlflow.md`:
- Around line 89-91: Vary the three bullet link texts to improve scanability by
rewording each prefix: change "[MLflow Tracing]" to something like "Tracing with
MLflow" (for the tracing guide), "[MLflow OpenTelemetry Integration]" to
"OpenTelemetry in MLflow" (for the OpenTelemetry support page), and "[MLflow
VoltAgent Guide]" to "VoltAgent setup (MLflow)" or "Setting up VoltAgent" (for
the VoltAgent tutorial); update the displayed link labels in the three list
items so they differ while keeping the same URLs.
ℹ️ Review info
Configuration used: defaults
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
website/static/img/mlflow-tracing.pngis excluded by!**/*.png
📒 Files selected for processing (2)
website/docs/observability/mlflow.mdwebsite/sidebars.ts
|
Thank you so much @B-Step62 🔥 |
2 participants
PR Checklist
Please check if your PR fulfills the following requirements:
Bugs / Features
This is a doc update only and
pnpm changesetonly generated an empty file, hence I did not add it in this PR.Change
This PR adds a guide for tracing/observability integration with MLflow, an open-source LLMOps platform with 30MM monthly download. This guide helps users trace, evaluate, and monitor agents built with VoltAgent.
Summary by cubic
Add an MLflow observability guide showing how to send VoltAgent OpenTelemetry traces to MLflow’s /v1/traces using the OTLP protobuf exporter. Includes setup steps, required env vars, and a screenshot, and adds the page to the Observability sidebar.
Written for commit 95e4b1c. Summary will update on new commits.
Summary by CodeRabbit