GeezerVisonThe World Wide Web, restored to 800 pixels of glory. | ||||||||||||||||||||||||||||
| Home|About|Gaming cabinet|Archives|How it works|Starter sites | ||||||||||||||||||||||||||||
GeezerVison is showing github.com — Improve CodeQL tools download time telemetry by henrymercer · Pull Request #4105 · github/codeql-action Conversation
|
| Field | When populated | Meaning |
|---|---|---|
tools_download_duration_ms |
Download-then-extract only | Time spent downloading. Unchanged. |
tools_extraction_duration_ms |
Download-then-extract only | Time spent extracting. |
tools_total_duration_ms |
Always | Wall-clock for the whole operation. |
tools_total_duration_ms is the field to compare across the change, being the only one populated on both paths. The component fields are left unpopulated on the streaming path, where downloading and extracting overlap and cannot be told apart. tools_download_duration_ms keeps its existing meaning so earlier data remains comparable.
The total is wall-clock across the whole call, so where streaming fails it includes the failed attempt and its cleanup. Those runs stay identifiable: on Linux, a report containing tools_download_duration_ms is one where streaming failed.
Compressed bundle size is deliberately not reported. For the common case it is a function of CLI version and platform, so it is already knowable from the release assets — and the size saving is the part of this that can be predicted, whereas the durations are not.
No changelog entry, as there is no user-facing change.
Workflow types:
dynamic workflows (Default Setup, Code Quality, ...).Products:
analysis-kinds: code-scanning.analysis-kinds: code-quality.Environments:
github.com and/or GitHub Enterprise Cloud with Data Residency.src/tools-download.test.ts covers both paths and the fallback from streaming to download-then-extract.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
The streaming path reported no timings at all, so we have no data for the path that most runs take. It now reports a total duration, which is also populated on the download-then-extract path. That path additionally reports the extraction duration, which was previously computed but only logged. `downloadDurationMs` keeps its existing meaning of time spent downloading alone, so existing telemetry stays comparable. Co-authored-by: Copilot App <[email protected]> Copilot-Session: 628ce334-991a-4578-9c1b-93d2e96bbddb
Surface `tools_extraction_duration_ms` and `tools_total_duration_ms` from both the `init` and `setup-codeql` actions. Co-authored-by: Copilot App <[email protected]> Copilot-Session: 628ce334-991a-4578-9c1b-93d2e96bbddb
Co-authored-by: Copilot App <[email protected]> Copilot-Session: 628ce334-991a-4578-9c1b-93d2e96bbddb
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
Warning
Adds baseline telemetry for CodeQL bundle download and extraction durations across streaming and non-streaming paths.
Changes:
| File | Description |
|---|---|
src/tools-download.ts |
Measures and returns bundle timing data. |
src/tools-download.test.ts |
Tests timing reports across download paths. |
src/status-report.ts |
Defines the new telemetry fields. |
src/setup-codeql.test.ts |
Updates mocked download reports. |
src/setup-codeql-action.ts |
Sends timing telemetry from setup-codeql. |
src/init-action.ts |
Sends timing telemetry from init. |
lib/entry-points.js |
Generated artifact; excluded from review. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Sorry, something went wrong.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
There was an error while loading. Please reload this page.
Successfully merging this pull request may close these issues.
There was an error while loading. Please reload this page.