Skip to content

Update session management documentation to reflect current trace-based architecture#1097

Merged
areibman merged 2 commits intomainfrom
devin/1750452820-update-session-docs
Jun 23, 2025
Merged

Update session management documentation to reflect current trace-based architecture#1097
areibman merged 2 commits intomainfrom
devin/1750452820-update-session-docs

Conversation

@devin-ai-integration
Copy link
Copy Markdown
Contributor

Update Session Management Documentation to Reflect Current Architecture

Summary

This PR updates the AgentOps documentation to remove references to deprecated multi-session functionality and align with the current trace-based session management architecture.

Changes Made

Documentation Updates

  • Updated v1/usage/multiple-sessions.mdx: Completely rewrote to focus on concurrent traces instead of deprecated multi-session mode

    • Removed references to multi-session mode restrictions and MultiSessionException
    • Added modern trace-based API examples using start_trace() and end_trace()
    • Included migration guidance from legacy multi-session mode
    • Maintained backwards compatibility documentation for legacy session API
  • Updated v1/examples/multi_session.mdx: Renamed to "Concurrent Traces Example" and updated content

    • Replaced deprecated multi-session patterns with modern trace-based examples
    • Added examples using decorators, context managers, and the new API
    • Removed references to session patching and MultiSessionException
    • Maintained legacy session examples for backwards compatibility
  • Updated docs/mint.json: Removed navigation reference to the deprecated multiple-sessions page

Key Architectural Changes Documented

  1. No more multi-session mode: Removed documentation about entering/exiting multi-session mode
  2. Automatic LLM tracking: Updated to reflect that LLM calls are now automatically tracked without special session assignment
  3. Modern API patterns: Added examples using @trace, @agent, and @tool decorators
  4. Context managers: Documented the new context manager support for traces
  5. Backwards compatibility: Clearly documented that legacy session functions still work but wrap the modern trace API

Migration Impact

  • Users following the old multi-session documentation will now see current best practices
  • Legacy session API remains documented for backwards compatibility
  • Clear migration path provided for users moving from old patterns to new ones

Testing

  • Verified all internal links still work after content updates
  • Confirmed navigation structure is correct after removing multiple-sessions reference
  • Ensured examples reflect current SDK functionality

Related Issues

Addresses the need to update documentation to match the current trace-based session management implementation where multi-session mode restrictions have been removed.


Link to Devin run: https://app.devin.ai/sessions/50ad3ab6f8164ba9b7e3c031c4ef0f31

Requested by: braelyn@agentops.ai

…d architecture

- Updated multiple-sessions.mdx to focus on concurrent traces instead of deprecated multi-session mode
- Renamed and updated multi_session.mdx example to show modern trace-based API patterns
- Removed references to MultiSessionException and multi-session mode restrictions
- Updated mint.json navigation to remove reference to multiple-sessions page
- Added migration guidance from legacy multi-session mode to current implementation
- Maintained backwards compatibility documentation for legacy session API

Co-Authored-By: braelyn@agentops.ai <braelyn@agentops.ai>
@devin-ai-integration
Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

- Replace legacy session decorator examples with modern trace-based API
- Update card titles and descriptions to reflect concurrent traces
- Ensure consistency with updated session management documentation

Co-Authored-By: braelyn@agentops.ai <braelyn@agentops.ai>
@areibman areibman merged commit b5b22cd into main Jun 23, 2025
2 checks passed
@areibman areibman deleted the devin/1750452820-update-session-docs branch June 23, 2025 23:51
@Dwij1704
Copy link
Copy Markdown
Member

Dwij1704 commented Jun 24, 2025

These changes were made in V1 docs, which were referenced to V3 sdk :))

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants