docs: add telemetry.dev observability integration - #6716
Conversation
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 10 included reviews per hour; 9 remain after this review. 📝 WalkthroughWalkthroughAdds a telemetry.dev integration guide for CrewAI using OpenLIT and OpenTelemetry. Registers the guide in the observability documentation navigation. Changestelemetry.dev documentation
Merge Risk: ⚪ Minimal · up to This documentation-only change adds a telemetry.dev observability guide and navigation entry; no actionable merge-blocking risk remains beyond normal checks and review. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.) ✨ Finishing Touches🧪 Generate unit tests (beta)
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@docs/edge/en/observability/telemetry-dev.mdx`:
- Line 79: Replace the removed CrewAI integration link in the telemetry
documentation with a currently live telemetry.dev guide URL, preserving the
existing link text and Markdown format.
- Around line 24-37: Add
OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT=false to the
environment-variable setup in Step 2 before configuring telemetry export. Do not
document enabling message capture in this setup; keep prompt and completion
capture disabled unless explicit capture and redaction requirements are
established.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro Plus
Run ID: c5832d18-d5fa-4576-a3e2-f2fefa19fc97
📒 Files selected for processing (2)
docs/docs.jsondocs/edge/en/observability/telemetry-dev.mdx
|
|
||
| ## References | ||
|
|
||
| - [telemetry.dev CrewAI integration guide](https://telemetry.dev/integrations/crewai) |
There was a problem hiding this comment.
📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win
Replace the broken CrewAI reference.
This URL currently returns HTTP 404. Update it to a live telemetry.dev guide before publishing. ()
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In `@docs/edge/en/observability/telemetry-dev.mdx` at line 79, Replace the removed
CrewAI integration link in the telemetry documentation with a currently live
telemetry.dev guide URL, preserving the existing link text and Markdown format.
OpenLIT captures full prompts and completions into span attributes by default. Show the opt-out explicitly in the quickstart so privacy-conscious users don't ship message content to their telemetry backend unintentionally. Addresses CodeRabbit review feedback (security & privacy, major). Skipped its 404 report for the telemetry.dev CrewAI link: the URL is live (HTTP 200, no redirect), so the finding no longer reproduces.
1 participant
This adds a telemetry.dev observability guide using OpenLIT's existing CrewAI instrumentation, exporting traces over standard OTLP/HTTP, plus an entry in the Edge observability navigation. Only the Edge docs tree is touched; the page follows the structure of the existing observability guides.
Disclosure: I built telemetry.dev.