feat(telemetry): Add Semantic logging for to ApiRequestEvents

[kiranani]

Summary

Semantic logging was added for ApiResponseEvents and ApiErrorEvents previously. But, as noted here, there may be cases of dropped records. Thus having the request events logged separately can be helpful

Pre-Merge Checklist

• Updated relevant documentation and README (if needed)
• Added/updated tests (if needed)
• Noted breaking changes (if any)
• Validated on required platforms/methods:
  • MacOS
    • npm run
    • npx
    • Docker
    • Podman
    • Seatbelt
  • Windows
    • npm run
    • npx
    • Docker
  • Linux
    • npm run
    • npx
    • Docker

[gemini-code-assist]

Summary of Changes

Hello @kiranani, 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 significantly upgrades the telemetry system by implementing semantic logging for API request events. The primary goal is to provide a more granular and comprehensive view of API interactions, particularly for generative AI, by capturing additional context such as generation parameters and server details. This enhancement addresses previous concerns about potential data loss in telemetry records, ensuring that a richer, separate log is always available for analysis.

Highlights

• Enhanced API Request Telemetry: Introduced semantic logging for ApiRequestEvents to capture more detailed information about API interactions, especially for generative AI operations.
• Detailed Event Data: The ApiRequestEvent now includes comprehensive GenAIPromptDetails, encompassing generate_content_config, server information, and optionally, prompt contents.
• Dual Logging Mechanism: The logApiRequest function now emits two distinct log records for each API request: a standard log and a richer semantic log, ensuring more robust data collection.
• Configurable Prompt Logging: Prompt contents are only included in the semantic logs if the getTelemetryLogPromptsEnabled configuration flag is set, allowing for privacy control.

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 adds semantic logging for ApiRequestEvent, which is a great addition for better telemetry. The implementation is solid, with good test coverage for the new functionality. I've found one issue related to adherence to OpenTelemetry semantic conventions, where a response-specific attribute was being incorrectly added to request logs. I've provided a suggestion to fix this.