Skip to content

feat(telemetry): Ensure experiment IDs are included in OpenTelemetry logs#18747

Merged
kevin-ramdass merged 3 commits intomainfrom
kevin-ramdass/exp-logging
Feb 10, 2026
Merged

feat(telemetry): Ensure experiment IDs are included in OpenTelemetry logs#18747
kevin-ramdass merged 3 commits intomainfrom
kevin-ramdass/exp-logging

Conversation

@kevin-ramdass
Copy link
Copy Markdown
Contributor

Summary

This PR injects experiments.ids into all OpenTelemetry (OTel) events, ensuring experiment tracking parity with the existing Clearcut telemetry system.

Details

  • Synchronous Injection: Updates getCommonAttributes in packages/core/src/telemetry/telemetryAttributes.ts to append available experiment IDs as the experiments.ids array attribute, aligning with OTel semantic conventions.
  • Async Pre-loading: Wraps OTel emission for early lifecycle events (logCliConfiguration and logStartupStats in packages/core/src/telemetry/loggers.ts) with .then() blocks executing after config.getExperimentsAsync(). This guarantees that experiment configurations are loaded before emitting the payload.
  • Test Suite Updates: Adds getExperiments() and getExperimentsAsync() static variables to the Config mocks across loggers.test.ts, sdk.test.ts, and sanitize.test.ts. Refactored early-event test cases to asynchronously await until process.nextTick resolves the logging promises.

Related Issues

Related to #12244

How to Validate

Enable OTEL logging and verify experiment ids are logged.

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
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @kevin-ramdass, 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 significantly enhances the OpenTelemetry logging capabilities by ensuring that experiment IDs are consistently captured and included in all telemetry events. The changes involve modifying the core telemetry attribute collection logic and introducing asynchronous handling for early-stage events to guarantee that experiment configurations are fully loaded before any relevant data is emitted. This brings OpenTelemetry tracking in line with the existing Clearcut system, providing a more comprehensive view of experiment participation in logs.

Highlights

  • OpenTelemetry Experiment ID Integration: Integrated experiment IDs into all OpenTelemetry events to achieve parity with the existing Clearcut telemetry system, ensuring consistent tracking of experiment participation.
  • Asynchronous Experiment Pre-loading: Implemented asynchronous pre-loading for experiment configurations, specifically for early lifecycle telemetry events (logCliConfiguration and logStartupStats), to guarantee that complete experiment data is available before events are emitted.
  • Test Suite Enhancements: Updated test suites across loggers.test.ts, sdk.test.ts, and sanitize.test.ts to accommodate the new asynchronous experiment loading mechanism and mock the necessary getExperiments() and getExperimentsAsync() configuration properties.
Changelog
  • packages/core/src/telemetry/loggers.test.ts
    • Updated logCliConfiguration test to be asynchronous.
    • Added getExperiments and getExperimentsAsync properties to various Config mock objects.
    • Introduced await new Promise(process.nextTick) to ensure asynchronous operations complete before assertions.
    • Updated Telemetry Buffering test to be asynchronous.
  • packages/core/src/telemetry/loggers.ts
    • Modified logCliConfiguration to asynchronously wait for config.getExperimentsAsync() before emitting the log record.
    • Modified logStartupStats to asynchronously wait for config.getExperimentsAsync() before emitting the log record.
  • packages/core/src/telemetry/sanitize.test.ts
    • Added getExperiments and getExperimentsAsync properties to the createMockConfig function.
  • packages/core/src/telemetry/sdk.test.ts
    • Added getExperiments and getExperimentsAsync properties to the mockConfig in the beforeEach block.
    • Added a setTimeout await in initializeTelemetry test to ensure asynchronous initialization completes.
  • packages/core/src/telemetry/telemetryAttributes.ts
    • Updated getCommonAttributes to retrieve experiment IDs from the configuration and conditionally include them in the OpenTelemetry attributes if available.
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-cli
Copy link
Copy Markdown
Contributor

gemini-cli bot commented Feb 10, 2026

Hi @kevin-ramdass, thank you so much for your contribution to Gemini CLI! We really appreciate the time and effort you've put into this.

We're making some updates to our contribution process to improve how we track and review changes. Please take a moment to review our recent discussion post: Improving Our Contribution Process & Introducing New Guidelines.

Key Update: Starting January 26, 2026, the Gemini CLI project will require all pull requests to be associated with an existing issue. Any pull requests not linked to an issue by that date will be automatically closed.

Thank you for your understanding and for being a part of our community!

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

The pull request successfully integrates experiment IDs into OpenTelemetry logs, ensuring parity with the existing Clearcut telemetry system. The changes correctly introduce asynchronous pre-loading of experiment configurations for early lifecycle events and update the test suite to accommodate this new asynchronous behavior. However, the review identified potential issues with unhandled promise rejections in telemetry logging, which should be addressed for application stability. Overall, the modifications are well-aligned with the stated objectives, pending resolution of the identified asynchronous issues.

@github-actions
Copy link
Copy Markdown

github-actions bot commented Feb 10, 2026

Size Change: +506 B (0%)

Total Size: 23.9 MB

ℹ️ View Unchanged
Filename Size Change
./bundle/gemini.js 23.9 MB +506 B (0%)
./bundle/sandbox-macos-permissive-closed.sb 1.03 kB 0 B
./bundle/sandbox-macos-permissive-open.sb 890 B 0 B
./bundle/sandbox-macos-permissive-proxied.sb 1.31 kB 0 B
./bundle/sandbox-macos-restrictive-closed.sb 3.29 kB 0 B
./bundle/sandbox-macos-restrictive-open.sb 3.36 kB 0 B
./bundle/sandbox-macos-restrictive-proxied.sb 3.56 kB 0 B

compressed-size-action

@gemini-cli gemini-cli bot added area/enterprise Issues related to Telemetry, Policy, Quota / Licensing 🔒 maintainer only ⛔ Do not contribute. Internal roadmap item. labels Feb 10, 2026
@kevin-ramdass kevin-ramdass marked this pull request as ready for review February 10, 2026 19:51
@kevin-ramdass kevin-ramdass requested a review from a team as a code owner February 10, 2026 19:51
@kevin-ramdass kevin-ramdass added this pull request to the merge queue Feb 10, 2026
Merged via the queue into main with commit a217475 Feb 10, 2026
27 checks passed
@kevin-ramdass kevin-ramdass deleted the kevin-ramdass/exp-logging branch February 10, 2026 21:14
krsjenmt added a commit to krsjenmt/gemini-cli that referenced this pull request Feb 11, 2026
* Fix newline insertion bug in replace tool (google-gemini#18595)

* fix(evals): update save_memory evals and simplify tool description (google-gemini#18610)

* chore(evals): update validation_fidelity_pre_existing_errors to USUALLY_PASSES (google-gemini#18617)

* fix: shorten tool call IDs and fix duplicate tool name in truncated output filenames (google-gemini#18600)

* feat(cli): implement atomic writes and safety checks for trusted folders (google-gemini#18406)

* Remove relative docs links (google-gemini#18650)

* docs: add legacy snippets convention to GEMINI.md (google-gemini#18597)

* fix(chore): Support linting for cjs (google-gemini#18639)

Co-authored-by: Gal Zahavi <38544478+galz10@users.noreply.github.com>

* feat: move shell efficiency guidelines to tool description (google-gemini#18614)

* Added "" as default value, since getText() used to expect a string only and thus crashed when undefined...  Fixes google-gemini#18076   (google-gemini#18099)

* Allow @-includes outside of workspaces (with permission) (google-gemini#18470)

* chore: make `ask_user` header description more clear (google-gemini#18657)

* bug(core): Fix minor bug in migration logic. (google-gemini#18661)

* Harded code assist converter. (google-gemini#18656)

* refactor(core): model-dependent tool definitions (google-gemini#18563)

* feat: enable plan mode experiment in settings (google-gemini#18636)

* refactor: push isValidPath() into parsePastedPaths() (google-gemini#18664)

* fix(cli): correct 'esc to cancel' position and restore duration display (google-gemini#18534)

* feat(cli): add DevTools integration with gemini-cli-devtools (google-gemini#18648)

* chore: remove unused exports and redundant hook files (google-gemini#18681)

* Fix number of lines being reported in rewind confirmation dialog (google-gemini#18675)

* feat(cli): disable folder trust in headless mode (google-gemini#18407)

* Disallow unsafe type assertions (google-gemini#18688)

* Change event type for release (google-gemini#18693)

* feat: handle multiple dynamic context filenames in system prompt (google-gemini#18598)

* Properly parse at-commands with narrow non-breaking spaces (google-gemini#18677)

* refactor(core): centralize core tool definitions and support model-specific schemas (google-gemini#18662)

* feat(core): Render memory hierarchically in context. (google-gemini#18350)

* feat: Ctrl+O to expand paste placeholder (google-gemini#18103)

* fix(cli): Improve header spacing (google-gemini#18531)

* Feature/quota visibility 16795 (google-gemini#18203)

* docs: remove TOC marker from Plan Mode header (google-gemini#18678)

* Inline thinking bubbles with summary/full modes (google-gemini#18033)

Co-authored-by: Jacob Richman <jacob314@gmail.com>

* fix(ui): remove redundant newlines in Gemini messages (google-gemini#18538)

* test(cli): fix AppContainer act() warnings and improve waitFor resilience (google-gemini#18676)

* refactor(core): refine Security & System Integrity section in system prompt (google-gemini#18601)

* Fix layout rounding. (google-gemini#18667)

* docs(skills): enhance pr-creator safety and interactivity (google-gemini#18616)

* test(core): remove hardcoded model from TestRig (google-gemini#18710)

* feat(core): optimize sub-agents system prompt intro (google-gemini#18608)

* feat(cli): update approval mode labels and shortcuts per latest UX spec (google-gemini#18698)

* fix(plan): update persistent approval mode setting (google-gemini#18638)

Co-authored-by: Sandy Tao <sandytao520@icloud.com>

* fix: move toasts location to left side (google-gemini#18705)

* feat(routing): restrict numerical routing to Gemini 3 family (google-gemini#18478)

* fix(ide): fix ide nudge setting (google-gemini#18733)

* fix(core): standardize tool formatting in system prompts (google-gemini#18615)

* chore: consolidate to green in ask user dialog (google-gemini#18734)

* feat: add `extensionsExplore` setting to enable extensions explore UI. (google-gemini#18686)

* feat(cli): defer devtools startup and integrate with F12 (google-gemini#18695)

* ui: update & subdue footer colors and animate progress indicator (google-gemini#18570)

* test: add model-specific snapshots for coreTools (google-gemini#18707)

Co-authored-by: matt korwel <matt.korwel@gmail.com>

* ci: shard windows tests and fix event listener leaks (google-gemini#18670)

* fix: allow `ask_user` tool in yolo mode (google-gemini#18541)

* feat: redact disabled tools from system prompt (google-gemini#13597) (google-gemini#18613)

* Update Gemini.md to use the curent year on creating new files (google-gemini#18460)

* Code review cleanup for thinking display (google-gemini#18720)

* fix(cli): hide scrollbars when in alternate buffer copy mode (google-gemini#18354)

Co-authored-by: Jacob Richman <jacob314@gmail.com>

* Fix issues with rip grep (google-gemini#18756)

* fix(cli): fix history navigation regression after prompt autocomplete (google-gemini#18752)

* chore: cleanup unused and add unlisted dependencies in packages/cli (google-gemini#18749)

* Fix issue where Gemini CLI creates tests in a new file (google-gemini#18409)

* feat(telemetry): Ensure experiment IDs are included in OpenTelemetry logs (google-gemini#18747)

* feat(ux): added text wrapping capabilities to markdown tables (google-gemini#18240)

Co-authored-by: jacob314 <jacob314@gmail.com>

* Revert "fix(mcp): ensure MCP transport is closed to prevent memory leaks" (google-gemini#18771)

* chore(release): bump version to 0.30.0-nightly.20260210.a2174751d (google-gemini#18772)

* chore: cleanup unused and add unlisted dependencies in packages/core (google-gemini#18762)

* chore(core): update activate_skill prompt verbiage to be more direct (google-gemini#18605)

* Add autoconfigure memory usage setting to the dialog (google-gemini#18510)

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>

* fix(core): prevent race condition in policy persistence (google-gemini#18506)

Co-authored-by: Allen Hutchison <adh@google.com>

* fix(evals): prevent false positive in hierarchical memory test (google-gemini#18777)

* test(evals): mark all `save_memory` evals as `USUALLY_PASSES` due to unreliability (google-gemini#18786)

* feat(cli): add setting to hide shortcuts hint UI (google-gemini#18562)

* feat(core): formalize 5-phase sequential planning workflow (google-gemini#18759)

* Introduce limits for search results. (google-gemini#18767)

---------

Co-authored-by: Andrew Garrett <andrewgarrett@google.com>
Co-authored-by: N. Taylor Mullen <ntaylormullen@google.com>
Co-authored-by: Sandy Tao <sandytao520@icloud.com>
Co-authored-by: Gal Zahavi <38544478+galz10@users.noreply.github.com>
Co-authored-by: christine betts <chrstn@uw.edu>
Co-authored-by: Aswin Ashok <aswwwin@google.com>
Co-authored-by: Abhijith V Ashok <abhi2349jith@gmail.com>
Co-authored-by: Tommaso Sciortino <sciortino@gmail.com>
Co-authored-by: Jack Wotherspoon <jackwoth@google.com>
Co-authored-by: joshualitt <joshualitt@google.com>
Co-authored-by: Jacob Richman <jacob314@gmail.com>
Co-authored-by: Aishanee Shah <aishaneeshah@gmail.com>
Co-authored-by: Jerop Kipruto <jerop@google.com>
Co-authored-by: Adib234 <30782825+Adib234@users.noreply.github.com>
Co-authored-by: Christian Gunderman <gundermanc@gmail.com>
Co-authored-by: g-samroberts <158088236+g-samroberts@users.noreply.github.com>
Co-authored-by: Spencer <spencertang@google.com>
Co-authored-by: Dmitry Lyalin <dmitry.lyalin@lyalin.com>
Co-authored-by: matt korwel <matt.korwel@gmail.com>
Co-authored-by: Shreya Keshive <shreyakeshive@google.com>
Co-authored-by: Sri Pasumarthi <111310667+sripasg@users.noreply.github.com>
Co-authored-by: Keith Guerin <keithguerin@gmail.com>
Co-authored-by: Sehoon Shon <sshon@google.com>
Co-authored-by: Adam Weidman <65992621+adamfweidman@users.noreply.github.com>
Co-authored-by: Kevin Ramdass <ramdass.kevin@gmail.com>
Co-authored-by: Dev Randalpura <devrandalpura@google.com>
Co-authored-by: gemini-cli-robot <gemini-cli-robot@google.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: Brad Dux <959674+braddux@users.noreply.github.com>
Co-authored-by: Allen Hutchison <adh@google.com>
Co-authored-by: Abhijit Balaji <abhijitbalaji@google.com>
kuishou68 pushed a commit to iOfficeAI/aioncli that referenced this pull request Feb 27, 2026
liamhelmer pushed a commit to badal-io/gemini-cli that referenced this pull request Mar 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/enterprise Issues related to Telemetry, Policy, Quota / Licensing 🔒 maintainer only ⛔ Do not contribute. Internal roadmap item.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants