Enhance documentation and functionality for trace management#1012
Merged
Enhance documentation and functionality for trace management#1012
Conversation
- Updated `mint.json` to include new usage paths for trace decorators and manual trace control. - Revised `introduction.mdx` to reflect changes in session tracking terminology, replacing "sessions" with "traces" for clarity. - Expanded `quickstart.mdx` to introduce the `@trace` decorator and manual trace management examples. - Added new documentation files for `manual-trace-control.mdx` and `trace-decorator.mdx`, detailing advanced trace management techniques and usage patterns. - Updated `sdk-reference.mdx` to include new parameters for trace management and improved examples for initializing the AgentOps SDK. - Enhanced `tracking-agents.mdx` to demonstrate multi-agent workflows and coordination using the `@trace` decorator. These changes improve the clarity and usability of the AgentOps SDK, particularly around trace management and agent tracking.
Contributor
|
You the man Dwij! Gonna review this later |
areibman
requested changes
May 28, 2025
Contributor
areibman
left a comment
areibman
left a comment
There was a problem hiding this comment.
Dwij, as always, you produce great docs. Left some comments in here for suggested improvements
- Updated `introduction.mdx` to clarify the use of the `@trace` decorator for custom trace creation. - Revised `quickstart.mdx` to include examples of initializing AgentOps with manual trace control. - Improved `examples.mdx` by updating image links to use raw GitHub URLs for better accessibility. - Enhanced `manual-trace-control.mdx` to provide detailed examples of managing traces manually. - Updated `recording-operations.mdx` to emphasize the use of the `@trace` decorator for grouping operations. - Refined `sdk-reference.mdx` to clarify parameters for ending traces and the use of decorators. - Improved `tracking-agents.mdx` to demonstrate structured tracking with the `@agent` decorator in multi-agent systems. These changes improve the clarity and usability of the AgentOps SDK, particularly around trace management and agent tracking.
- Introduced a new module for Google Generative AI (Gemini) API instrumentation, including `GoogleGenAIInstrumentor` for capturing telemetry data. - Added attribute extraction functions for model and chat interactions, enhancing observability of API calls. - Implemented wrappers for synchronous and asynchronous streaming methods to track performance metrics. - Updated documentation to include usage examples and details on supported features for the new instrumentation. - Refactored existing code to accommodate the new module structure and improve clarity. These changes enhance the AgentOps SDK by providing comprehensive support for monitoring Google Generative AI interactions.
Codecov ReportAttention: Patch coverage is 📢 Thoughts on this report? Let us know! |
…the correct position in the integrations list. This change improves the organization and accessibility of integration documentation.
Member
Author
|
Renamed google-generativeai to google-genai in this PR @bboynton97 |
areibman
approved these changes
May 28, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
mint.jsonto include new usage paths for trace decorators and manual trace control.introduction.mdxto reflect changes in session tracking terminology, replacing "sessions" with "traces" for clarity.quickstart.mdxto introduce the@tracedecorator and manual trace management examples.manual-trace-control.mdxandtrace-decorator.mdx, detailing advanced trace management techniques and usage patterns.sdk-reference.mdxto include new parameters for trace management and improved examples for initializing the AgentOps SDK.tracking-agents.mdxto demonstrate multi-agent workflows and coordination using the@tracedecorator.These changes improve the clarity and usability of the AgentOps SDK, particularly around trace management and agent tracking.
📥 Pull Request
📘 Description
Briefly describe the changes you've made.
🧪 Testing
Describe the tests you performed to validate your changes.