fix: Path fix for logging

[zarinn3pal]

This Pr fixes the path issue for google cloud logging encountered in AIM telemetry. It is an extension to the following PR:

#4530

[gemini-code-assist]

Summary of Changes

Hello @zarinn3pal, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request resolves a critical pathing issue affecting Google Cloud logging within AIM telemetry by implementing a robust system for managing tracing paths. The changes ensure that when actions are nested, their OpenTelemetry spans accurately reflect their hierarchical relationship, leading to more precise and reliable logging data. This fix is crucial for maintaining the integrity of tracing information in complex Genkit applications.

Highlights

• Path Management for Tracing: Introduced a new mechanism to correctly manage hierarchical paths for nested spans in OpenTelemetry tracing, specifically addressing issues in Google Cloud logging for AIM telemetry.
• Context Variable for Parent Path: Implemented ContextVar to store and retrieve the current parent path, ensuring proper context propagation across asynchronous and synchronous calls.
• Path Building Utilities: Added utility functions (build_path, decorate_path_with_subtype) to construct and annotate hierarchical paths with type and subtype information.
• Tracing Wrapper Enhancements: Modified async_tracing_wrapper and sync_tracing_wrapper to save and restore the parent path context around span creation, preventing path corruption in nested operations.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• py/packages/genkit/src/genkit/core/action/_action.py
  • Imported get_parent_path and set_parent_path from _tracing module.
  • Wrapped tracer.start_as_current_span calls in try...finally blocks within async_tracing_wrapper and sync_tracing_wrapper to save and restore the parent path context.
• py/packages/genkit/src/genkit/core/action/_tracing.py
  • Added ContextVar named _parent_path_context to manage the current parent path.
  • Introduced build_path function for creating annotated hierarchical paths.
  • Added decorate_path_with_subtype function to append subtype information to path segments.
  • Implemented get_parent_path and set_parent_path functions to interact with the _parent_path_context.
  • Updated record_input_metadata to utilize the new path management functions, setting genkit:path and genkit:qualifiedPath attributes on the span and updating the context for nested spans.

Activity

• No specific activity has been recorded for this pull request yet.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[gemini-code-assist]

Code Review

This pull request introduces a path-building mechanism for telemetry logging, using a context variable to track parent paths for nested spans. The use of try...finally to manage the context is a good defensive measure. My review includes a few points for improvement. I've identified a potential issue in build_path where unescaped characters in names could lead to malformed paths. I've also provided a suggestion to make the logic in decorate_path_with_subtype more robust. Additionally, I've pointed out an opportunity to reduce code duplication in _action.py for better maintainability.