Skip to content

Add telemetry event for index updates#6175

Merged
JohnMcPMS merged 1 commit intomicrosoft:masterfrom
JohnMcPMS:index-update-telem
Apr 27, 2026
Merged

Add telemetry event for index updates#6175
JohnMcPMS merged 1 commit intomicrosoft:masterfrom
JohnMcPMS:index-update-telem

Conversation

@JohnMcPMS
Copy link
Copy Markdown
Member

@JohnMcPMS JohnMcPMS commented Apr 24, 2026

Change

Adds a telemetry event to collect data on index update frequency. This data will be used to help us optimize default update check interval and for a potential future feature of delta index updates. It is designed with that feature in mind, including some fields that will only be set differently when/if it is implemented.

The collected data is:

Field Type Nullable Description
SourceId string No Identifier of the source being updated (for per-source stratification)
PreviousIndexPublishedAt datetime Yes Timestamp embedded in the previously-held index. Null for net-new clients (no prior index).
NewIndexPublishedAt datetime No Timestamp embedded in the newly-downloaded index.
IndexStalenessDays float Yes (NewIndexPublishedAt − PreviousIndexPublishedAt).TotalDays. Pre-computed for pipeline convenience. Null when PreviousIndexPublishedAt is null.
IsNewClient bool No True when PreviousIndexPublishedAt is null. Pre-computed; simplifies pipeline filtering for net-new client cohort.
UsedDeltaDownload bool No True if the client downloaded a delta file rather than a full index. False for non-delta-capable clients or when no delta was available.
PreviousBaselinePublishedAt datetime Yes Timestamp of the baseline the client held before this update. Null if client had no baseline (non-delta, or net-new delta client).
NewBaselinePublishedAt datetime Yes Timestamp of the baseline in use after this update. Null if UsedDeltaDownload is false.
BaselineStalenessDays float Yes (NewBaselinePublishedAt − PreviousBaselinePublishedAt).TotalDays. Pre-computed. Null when either baseline timestamp is null.
BaselineUpdated bool No True if the client downloaded a new baseline as part of this update cycle. Pre-computed; avoids requiring consumers to diff baseline timestamps.
DownloadedBytes long No Total bytes transferred for this update (baseline + delta, or full index). Actual bytes on the wire.
IsManualUpdate bool No True if the update was directly user initiated; false if it was done automatically.
Microsoft Reviewers: Open in CodeFlow

@JohnMcPMS JohnMcPMS requested a review from a team as a code owner April 24, 2026 22:23
@JohnMcPMS JohnMcPMS merged commit 1490d3c into microsoft:master Apr 27, 2026
9 checks passed
@JohnMcPMS JohnMcPMS deleted the index-update-telem branch April 27, 2026 16:28
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