docs: add Respan observability integration

[Nightingalelyy]

docs: add Respan observability integration

Summary by CodeRabbit

Documentation

• Added comprehensive documentation for Respan integration, enabling users to trace CrewAI workflows and optionally route LLM calls through the Respan gateway. Includes installation steps, environment configuration, setup instructions, and metadata attachment guidance.

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR adds documentation for integrating Respan distributed tracing with CrewAI. The change registers a new documentation page in the structure, adds a reference card in the observability overview, and provides comprehensive guidance on setup, LLM routing configuration, metadata propagation, and resource links.

Changes

Respan Integration Documentation

Layer / File(s)	Summary
Documentation structure registration docs/docs.json, docs/en/observability/overview.mdx	Documentation index updated to include en/observability/respan path, and a new Respan card added to the Monitoring & Tracing Platforms grid in the observability overview.
Respan integration guide content docs/en/observability/respan.mdx	New documentation file with frontmatter, overview of Respan instrumentation, end-to-end CrewAI setup example, LLM routing through Respan gateway via OPENAI_BASE_URL configuration, user/request metadata attachment and propagation guidance, configuration table for environment variables and CrewAIInstrumentor options, and links to Respan dashboard and integration resources.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

📚 A trace through the clouds, so clear and bright,
Respan's observability shines with light,
CrewAI crews now reveal their every flight,
With routing and metadata held just right,
Documentation guides the user's sight. 🐇✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: add Respan observability integration' directly and clearly summarizes the main change: adding documentation for Respan observability integration.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

docs/en/observability/overview.mdx (1)

62-64: 💤 Low value

Icon duplication: Respan and Langtrace both use chart-line.

Consider choosing a different icon for Respan (e.g., radar, network-wired, activity) to maintain visual distinctiveness in the card grid. This is a minor UX consideration and could be deferred if icon options are limited.

🤖 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/en/observability/overview.mdx` around lines 62 - 64, The Respan Card
currently reuses the same icon as Langtrace (Card with title="Respan" and
icon="chart-line"), causing visual duplication; update the icon prop on that
Card to a distinct option (e.g., change icon="chart-line" to icon="radar" or
"network-wired" or "activity") so the Respan card is visually distinct in the
grid.

🤖 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/docs.json`:
- Around line 342-347: The docs.json observability list is out of alphabetical
order: entries "en/observability/weave" and "en/observability/truefoundry" are
swapped; keep "en/observability/truefoundry" before "en/observability/weave" so
the sequence (including "en/observability/respan") is alphabetically ordered by
integration name; edit the array in docs/docs.json to swap those two strings
accordingly.

---

Nitpick comments:
In `@docs/en/observability/overview.mdx`:
- Around line 62-64: The Respan Card currently reuses the same icon as Langtrace
(Card with title="Respan" and icon="chart-line"), causing visual duplication;
update the icon prop on that Card to a distinct option (e.g., change
icon="chart-line" to icon="radar" or "network-wired" or "activity") so the
Respan card is visually distinct in the grid.

🪄 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: 302e7d54-6e73-473e-afeb-9ac026773f4c

📥 Commits

Reviewing files that changed from the base of the PR and between 373dca3 and cb6e591.

📒 Files selected for processing (3)

• docs/docs.json
• docs/en/observability/overview.mdx
• docs/en/observability/respan.mdx

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Verify the referenced Respan documentation file exists
fd -type f "respan.mdx" docs/

# Check the full observability list to confirm alphabetical ordering
rg -n "en/observability/" docs/docs.json -A 20 -B 5

Repository: crewAIInc/crewAI

Length of output: 36402

---

🏁 Script executed:

#!/bin/bash
set -e

# 1) Locate the referenced documentation file (correct fd usage: search by name pattern)
fd -a "respan\.mdx$" . || true

# 2) Show the observability pages list area (context around the integration entries)
rg -n "\"group\": \"Observability\"" docs/docs.json
rg -n "en/observability/" docs/docs.json -A 25 -B 10

# 3) Check what changed specifically in this file (so we can tell if ordering was broken by the new insertion)
git diff -U5 -- docs/docs.json | sed -n '1,200p'

Repository: crewAIInc/crewAI

Length of output: 48106

---

🏁 Script executed:

#!/bin/bash
set -e

# Where respan is referenced
rg -n "en/observability/respan" docs/docs.json

# Show surrounding context for the specific line range in question
sed -n '300,380p' docs/docs.json

# Show how this file changed in the PR (only around the relevant area if possible)
git diff -U10 -- docs/docs.json | sed -n '1,220p'

Repository: crewAIInc/crewAI

Length of output: 3838

---

🏁 Script executed:

#!/bin/bash
set -e

git diff -U15 -- docs/docs.json | rg -n "observability/(respan|weave|truefoundry|portkey|opik)" -n || true
git diff -U30 -- docs/docs.json | sed -n '1,200p'

Repository: crewAIInc/crewAI

Length of output: 42

---

Fix ordering in Observability docs list (docs/docs.json lines 342-347)

docs/en/observability/respan.mdx exists, and en/observability/respan is correctly registered. However, the list orders en/observability/weave before en/observability/truefoundry; swap them to keep alphabetical order by integration name.

🤖 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/docs.json` around lines 342 - 347, The docs.json observability list is
out of alphabetical order: entries "en/observability/weave" and
"en/observability/truefoundry" are swapped; keep "en/observability/truefoundry"
before "en/observability/weave" so the sequence (including
"en/observability/respan") is alphabetically ordered by integration name; edit
the array in docs/docs.json to swap those two strings accordingly.

[github-actions]

This PR is stale because it has been open for 45 days with no activity.