Skip to content

docs(agenteye): document Python SDK framework instrumentation - #631

Open
NiveditJain wants to merge 2 commits into
mainfrom
docs/agenteye-python-sdk-async
Open

docs(agenteye): document Python SDK framework instrumentation#631
NiveditJain wants to merge 2 commits into
mainfrom
docs/agenteye-python-sdk-async

Conversation

@NiveditJain

@NiveditJain NiveditJain commented Jul 31, 2026

Copy link
Copy Markdown
Member

Summary

  • document native LangChain/LangGraph, CrewAI, LlamaIndex, and Pydantic AI instrumentation
  • document the RunnableConfig handoff required for async LangGraph child calls on Python 3.10

Companion to FailproofAI/agenteye#503.

Validation

  • bun run validate:mdx: 720 pages parsed cleanly
  • mintlify validate: unavailable in the local environment

Summary by CodeRabbit

  • Documentation
    • Added guidance for enabling automatic instrumentation across popular AI frameworks.
    • Documented optional framework-specific instrumentation configuration.
    • Added Python 3.10 guidance for preserving LangGraph activity context in asynchronous workflows.
    • Clarified that Python 3.11 and later handle this context propagation automatically.
    • Updated the changelog with these instrumentation details.

@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: c6b4f62a-8023-404a-a674-d900661b7f96

📥 Commits

Reviewing files that changed from the base of the PR and between debb1fd and 8214568.

📒 Files selected for processing (2)
  • CHANGELOG.md
  • docs/agenteye/python-sdk.mdx

📝 Walkthrough

Walkthrough

The documentation now describes AgentEye framework instrumentation for supported frameworks. It includes the agenteye.instrument() usage pattern and Python 3.10 guidance for propagating RunnableConfig in LangGraph async nodes. The changelog records these documentation updates.

Changes

Framework instrumentation documentation

Layer / File(s) Summary
Instrumentation guidance and release notes
docs/agenteye/python-sdk.mdx, CHANGELOG.md
The SDK documentation describes supported frameworks, agenteye.instrument(), optional framework selection, and Python-version-specific LangGraph configuration. The changelog records the update.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested labels: enhancement

Suggested reviewers: hermes-exosphere

Poem

A rabbit hops through docs so bright,
Instrumentation springs to light.
LangGraph carries config with care,
Framework guidance blooms everywhere.
Thump, thump—clean notes in flight!

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the changes and validation, but it omits the required Description, Type of Change, and Checklist sections. Use the repository template headings and select Documentation under Type of Change; complete or mark each required checklist item.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly identifies the documentation change for Python SDK framework instrumentation.
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.

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

docs/agenteye/python-sdk.mdx

ESLint skipped: missing config or dependency (missing-dependency). The ESLint configuration references a package that is not available in the sandbox.


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

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot added the enhancement New feature or request label Jul 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant