Skip to content

feat(librarian): write a timing log at the end of update-image#2771

Merged
jskeet merged 3 commits intogoogleapis:mainfrom
jskeet:update-image-timing
Nov 4, 2025
Merged

feat(librarian): write a timing log at the end of update-image#2771
jskeet merged 3 commits intogoogleapis:mainfrom
jskeet:update-image-timing

Conversation

@jskeet
Copy link
Copy Markdown
Contributor

@jskeet jskeet commented Nov 4, 2025

This writes a file rather than logging the timing of each library to avoid cluttering up the logs, and to make it easier to look at just timing.

At the moment this only writes a timing log for update-image, but the writeTiming function is designed to make it easy to call from any other comamnd (e.g. release init or generate) if we want.

This writes a file rather than logging the timing of each library to
avoid cluttering up the logs, and to make it easier to look at just
timing.

At the moment this only writes a timing log for update-image, but the
writeTiming function is designed to make it easy to call from any
other comamnd (e.g. release init or generate) if we want.
@jskeet jskeet requested a review from a team as a code owner November 4, 2025 14:47
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @jskeet, 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 enhances the librarian tool by implementing a mechanism to record and output the processing time for each library during the update-image operation. Instead of logging this information directly, it's now written to a dedicated timing.txt file, which streamlines performance diagnostics by providing a clear, sortable record of how long each library takes to process.

Highlights

  • Timing Log File Generation: Introduced a new feature to write a detailed timing log to a file (timing.txt) at the end of the update-image command execution. This avoids cluttering standard logs and provides a dedicated, structured output for performance analysis.
  • Reusable Timing Function: A new writeTiming function has been added, designed to be easily callable from other commands (e.g., release init or generate) if timing data is needed for those operations in the future.
  • Detailed Timing Data: The timing log includes a summary line with the total and average processing time for all libraries, followed by individual library timings sorted in descending order of duration, rounded to the nearest millisecond.
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
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello @jskeet, 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 enhances the librarian tool by implementing a mechanism to capture and persist performance metrics for library processing during the update-image operation. Instead of logging timing information directly to the console, which can be verbose, the system now generates a dedicated timing.txt file. This file provides a clear, structured overview of how long each library took to process, making it easier to analyze performance and identify areas for optimization. The underlying timing utility is built for future extensibility to other commands.

Highlights

  • New Timing Log File: Introduced a new feature to write a detailed timing log to a file (timing.txt) at the end of the update-image command execution. This avoids cluttering standard logs with performance data.
  • Reusable Timing Function: A new writeTiming function has been added, designed to be easily callable from other commands (e.g., release init or generate) if timing logs are desired for those operations in the future.
  • Performance Insights: The timing log includes a summary of processed libraries, total time, average time, and individual library processing times, sorted in descending order of duration to highlight potential bottlenecks.
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.

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

This pull request introduces a timing log for the update-image command, which is a great addition for performance monitoring. My review includes a critical fix to prevent a panic when no libraries are processed, along with suggestions to improve efficiency, test coverage, and the usefulness of the timing data by including failed generations.

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

This pull request introduces a timing log for the update-image command, which is a great addition for performance monitoring. The implementation is mostly solid, but I've identified a critical bug that could cause a panic, and another area for improvement in logic. Please see my detailed comments below.

@codecov
Copy link
Copy Markdown

codecov bot commented Nov 4, 2025

Codecov Report

❌ Patch coverage is 93.54839% with 2 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.76%. Comparing base (d5ac6c8) to head (924df22).
⚠️ Report is 5 commits behind head on main.

Files with missing lines Patch % Lines
internal/librarian/update_image.go 60.00% 1 Missing and 1 partial ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2771      +/-   ##
==========================================
+ Coverage   86.74%   86.76%   +0.02%     
==========================================
  Files         119      119              
  Lines       10152    10183      +31     
==========================================
+ Hits         8806     8835      +29     
- Misses        947      948       +1     
- Partials      399      400       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Contributor

@ldetmer ldetmer left a comment

Choose a reason for hiding this comment

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

looks good, can you add the check that gemini requested

Copy link
Copy Markdown
Contributor Author

@jskeet jskeet left a comment

Choose a reason for hiding this comment

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

I hadn't realised I hadn't sent my review...

@ldetmer ldetmer self-requested a review November 4, 2025 18:50
@jskeet jskeet merged commit 5fc9e3b into googleapis:main Nov 4, 2025
7 checks passed
@jskeet jskeet deleted the update-image-timing branch November 4, 2025 18:55
ldetmer added a commit that referenced this pull request Nov 6, 2025
PR created by the Librarian CLI to initialize a release. Merging this PR
will auto trigger a release.

Librarian Version: not available
Language Image:
us-central1-docker.pkg.dev/cloud-sdk-librarian-prod/images-prod/librarian-release-container:latest
<details><summary>librarian: 1.0.0</summary>

##
[1.0.0](v0.5.0...v1.0.0)
(2025-11-06)

### Features

* Remove `..._gax` dependency (#2713)
([01675b7](01675b72))

* add context to Librarian PRs (#2698)
([0523329](0523329a))

* add a package comment linter (#2712)
([1bd3e32](1bd3e32e))

* generate pom.xml files (#2682)
([50b95f2](50b95f20))

* add test-container test logic (#2656)
([514cf7e](514cf7e5))

* improve rust-publish logging (#2671)
([585ed50](585ed50b))

* write a timing log at the end of update-image (#2771)
([5fc9e3b](5fc9e3b6))

* migrate Java container from sdk-platform-java (#2670)
([69ac47f](69ac47fd))

* switch to original head after running update-image (#2696)
([7a3e404](7a3e404a))

* format bulk commit from other sources in release notes (#2665)
([7c52da2](7c52da2b))

* enable multi-version API generation (#2699)
([86c5250](86c52507))

* release stage to update pom.xml files (#2772)
([be56755](be567550))

* use proto presence info to generate null-safe code (#2726)
([e36fb81](e36fb81a))

* Base messages in google_cloud_protobuf (#2660)
([e607ea6](e607ea63))

### Bug Fixes

* retry Github 503 requests up to 3 times (#2650)
([09468fa](09468faf))

* Changed docs to ConfigurationException (#2697)
([0950c1e](0950c1e3))

* fix the reference to the old &#34;librariangen&#34; folder (#2677)
([09dc53f](09dc53fe))

* run godoclint via golangci-lint (#2751)
([264a6a0](264a6a0e))

* pass context as the first argument (#2769)
([298a3bd](298a3bd8))

* Move HTTP client creation to `_gax` (#2672)
([4968d63](4968d63d))

* deduplicate bulk commits (#2758)
([4dfae9a](4dfae9ae))

* Support additional api paths for an existing library (#2666)
([50046f5](50046f55))

* remove stray TODO (#2748)
([5072f0e](5072f0e0))

* omit status field when empty (#2654)
([572ae4f](572ae4f3))

* use T.Context in tests (#2768)
([7e7cd2d](7e7cd2dd))

* wrap error to provide more context for commitAndPush (#2767)
([a2a41a4](a2a41a4a))

* use t.Fatal in tests for proper failure handling (#2759)
([cdabb28](cdabb287))

* enforce removal before copying library files (#2765)
([d5ac6c8](d5ac6c87))

* change log level to debug (#2798)
([f042d0b](f042d0bd))

* change path to `doc.go` in docgen test (#2700)
([fd6bae4](fd6bae40))

### Documentation

* use consistent library id in flags and examples (#2770)
([87a1005](87a10056))

</details>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants