[Telemetry] Add support to collect Toolkit installation mode#5598
Conversation
Summary of ChangesHello, I'm Gemini Code Assist1! 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 introduces a mechanism to track the installation mode of the toolkit within the telemetry system. By injecting the installation mode during the build process and passing it through the application's telemetry pipeline, the project can now better understand how the toolkit is being deployed and used in different environments. Highlights
Using Gemini Code AssistThe 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
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 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. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces an INSTALLATION_MODE variable to track the toolkit's installation method and includes it in telemetry data. The changes involve updating the build process in the Makefile, the main command execution, and the telemetry collector. Feedback indicates that the gitIsOfficial flag was inadvertently removed from the build command, which will affect version reporting. Additionally, the INSTALLATION_MODE definition in the Makefile should be unquoted to avoid literal quotes in the binary, and unit tests should be updated to explicitly verify the new telemetry metadata.
|
/gemini review |
There was a problem hiding this comment.
Code Review
This pull request adds an INSTALLATION_MODE variable to track the toolkit's installation source and includes it in telemetry data. Feedback recommends removing double quotes from the Makefile variable to avoid literal quotes in the Go binary and updating unit tests to validate that the new telemetry field is correctly captured in the metadata.
I am having trouble creating individual review comments. Click here to see my feedback.
Makefile (19)
In Makefiles, string values are typically defined without quotes unless the quotes are intended to be part of the value itself. When passed to Go via ldflags, this will result in the variable containing literal double quotes (e.g., "SOURCE" instead of SOURCE). To ensure consistency with other build-time variables and correct behavior in the Go code, please remove the quotes.
INSTALLATION_MODE = SOURCE
pkg/telemetry/collector_test.go (172)
While updating the call to CollectMetrics to include the new installationMode parameter, the test logic should also be updated to verify that this value is correctly stored in the collector's metadata. This would involve adding INSTALLATION_MODE to the expectedKeys slice and the corresponding expected value to the expectedValues maps within TestCollectMetrics_Extensible. Additionally, TestBuildConcordEvent should be updated to verify this new field in the generated event metadata.
ded509b
into
GoogleCloudPlatform:develop
This pull request introduces a mechanism to track the installation mode of the toolkit within the telemetry system. By injecting the installation mode during the build process and passing it through the application's telemetry pipeline, the project can now better understand how the toolkit is being deployed and used in different environments. For now, the Source Installation mode is being supported. Support for the Binary mode will be implemented shortly using the same workflow.
Changes: