Skip to content

Overlay: report telemetry #2975

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Overlay: report telemetry #2975

wants to merge 4 commits into from

Conversation

cklin
Copy link
Contributor

@cklin cklin commented Jul 17, 2025

This PR adds telemetry fields for overlay analysis.

  • analysis_is_overlay
  • analysis_builds_overlay_base_database
  • overlay_base_database_download_size_bytes
  • overlay_base_database_download_duration_ms

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Confirm the readme has been updated if necessary.
  • Confirm the changelog has been updated if necessary.

@cklin cklin marked this pull request as ready for review July 17, 2025 18:13
@Copilot Copilot AI review requested due to automatic review settings July 17, 2025 18:13
@cklin cklin requested a review from a team as a code owner July 17, 2025 18:13
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR adds telemetry tracking for overlay database analysis operations. The changes enable the CodeQL Action to collect and report statistics about overlay-base database downloads and analysis modes.

  • Modified the download function to return telemetry statistics instead of a boolean
  • Added new telemetry fields to track download size, duration, and analysis modes
  • Expanded test coverage for the updated download function behavior

Reviewed Changes

Copilot reviewed 8 out of 12 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/overlay-database-utils.ts Updated download function to return telemetry stats and measure database size/download time
src/overlay-database-utils.test.ts Added comprehensive test cases for the modified download function
src/init-action.ts Updated to capture and pass overlay database stats to telemetry reporting
src/analyze.ts Added telemetry flags to track overlay vs overlay-base analysis modes
lib/* Generated JavaScript files reflecting the TypeScript changes

@cklin cklin force-pushed the cklin/overlay-telemetry branch from 76a1b2d to 2b3bae6 Compare July 17, 2025 18:21
@cklin cklin requested a review from mbg July 17, 2025 19:03
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.

1 participant