Optional Telemetry Event for Microsoft Store Catalog Installs (msstore Source) by shmuelie · Pull Request #6352 · microsoft/winget-cli

shmuelie · 2026-07-06T21:44:07Z

📖 Description

Adds an optional telemetry event that lets Microsoft Store analytics attribute Store‑catalog
app installs that happen through WinGet.

When WinGet successfully installs an app whose source is the Microsoft Store (msstore), it now
emits a StoreExperienceTelemetry-WinGetInstall event on the Microsoft-Windows-Store ETW
provider ({9C2A37F3-E5FD-5CAE-BCD1-43DAFEEE1FF0}). The event carries only the minimum needed for
attribution:

Field	Value
`pid`	Store product ID (the `msstore` package identifier)
`src`	Install caller
`cn`	Catalog name — constant `"msstore"`

Key points:

Emitted only on success, only for msstore. The call site is the success path of
ReportInstallerResult, gated on
PackageVersion->GetSource().IsWellKnownSource(WellKnownSource::MicrosoftStore). Local‑manifest
installs (which have no PackageVersion) are guarded with Contains(...) so they are unaffected.
Scope: unpackaged (Win32) Store apps. Unpackaged msstore items resolve to a real installer
type (exe/msi) and flow through ReportInstallerResult, so they emit the event.
New dedicated provider. Microsoft-Windows-Store is registered alongside the existing WinGet
provider, with its own enablement callback (g_IsStoreTelemetryProviderEnabled) so the Store
event can be captured independently of the WinGet telemetry provider.
Privacy‑preserving. The event honors the WinGet telemetry opt‑out
(m_isSettingEnabled), the runtime toggle (m_isRuntimeEnabled), and initialization state, and
is tagged PDT_ProductAndServicePerformance / MICROSOFT_KEYWORD_CRITICAL_DATA. It records no
executable paths, usernames, or command‑line arguments.

Files changed

File	Change
`src/AppInstallerCommonCore/Telemetry/TraceLogging.{h,cpp}`	Declare/define the `Microsoft-Windows-Store` provider + register its enablement callback
`src/AppInstallerCommonCore/Public/AppInstallerTelemetry.h`	Declare `LogStoreInstall`
`src/AppInstallerCommonCore/AppInstallerTelemetry.cpp`	Implement `LogStoreInstall` (writes the event; updates the telemetry summary when the WinGet provider is enabled)
`src/AppInstallerCLICore/Workflows/InstallFlow.cpp`	Call `LogStoreInstall` on successful `msstore` installs, guarded by `Contains(PackageVersion)`

🔗 References

Resolves #6317

🔍 Validation

CLI, unpackaged Store app (confirmed): winget install XPFFH613W8V6LV --accept-package-agreements (OBS Studio — an unpackaged exe Store app). An ETW capture of the
Microsoft-Windows-Store provider showed StoreExperienceTelemetry-WinGetInstall with pid =
the Store product ID and cn = msstore.
Negative cases: no event for non‑msstore sources, and none for a failed install (the event
is only reached on the success path).
Privacy: event is suppressed when WinGet telemetry is disabled via settings or the runtime
toggle.

✅ Checklist

Signed the Contributor License Agreement
Linked to an issue
Updated Release Notes (if applicable)
Updated documentation (if applicable)
Updated Copilot instructions (if build, architecture, or conventions changed)

📋 Issue Type

Bug fix
Feature
Task

Microsoft Reviewers: Open in CodeFlow

florelis · 2026-07-15T21:38:24Z

+            TraceLoggingWrite(g_hWindowsStoreProvider,
+                "StoreExperienceTelemetry-WinGetInstall",
+                TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
+                TraceLoggingKeyword(MICROSOFT_KEYWORD_CRITICAL_DATA),


Does it need to be critical?

Copilot

Pull request overview

This PR adds an optional ETW telemetry event to enable Microsoft Store analytics to attribute successful WinGet installs originating from the msstore source by emitting StoreExperienceTelemetry-WinGetInstall on the Microsoft-Windows-Store provider, and wires up the necessary provider enablement plumbing. It also updates the vcpkg triplet common settings.

Changes:

Register a new TraceLogging provider (Microsoft-Windows-Store) with its own enablement callback/flag.
Add TelemetryTraceLogger::LogStoreInstall() and invoke it on successful msstore installs that flow through ReportInstallerResult.
Set VCPKG_PLATFORM_TOOLSET to v143 in the shared vcpkg triplet configuration.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/VcpkgCustomTriplets/common.cmake	Forces the vcpkg toolset to `v143` for triplets.
src/AppInstallerCommonCore/Telemetry/TraceLogging.h	Declares the new Windows Store TraceLogging provider + enabled flag.
src/AppInstallerCommonCore/Telemetry/TraceLogging.cpp	Defines/registers/unregisters the Windows Store provider and enablement callback.
src/AppInstallerCommonCore/Public/AppInstallerTelemetry.h	Exposes `LogStoreInstall()` on the telemetry logger.
src/AppInstallerCommonCore/AppInstallerTelemetry.cpp	Implements `LogStoreInstall()` and writes the Store attribution event.
src/AppInstallerCLICore/Workflows/InstallFlow.cpp	Calls `LogStoreInstall()` on the successful installer-result path for `msstore` package versions.

…ore provider

ReportInstallerResult's success branch fetched Execution::Data::PackageVersion unconditionally to decide whether to emit the msstore install telemetry event. Get<> throws E_NOT_SET when the key is absent, and the --manifest install path (GetManifestFromArg) never adds PackageVersion, so a successful local-manifest install threw at the reporting stage and was reported as an error. Guard the access with Contains(Execution::Data::PackageVersion) before Get, and only fetch the Manifest when actually emitting. Store installs (which always have a PackageVersion) are unaffected; --manifest installs now skip the block instead of throwing. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

- LogStoreInstall: stop editing the telemetry SummaryV2 fields. The summary is the single end-of-run event and is populated elsewhere, so the Store-install path should not overwrite SourceIdentifier/PackageIdentifier (per review). - LogStoreInstall: drop the redundant AICLI_LOG; the install is already logged upstream. - common.cmake: remove the VCPKG_PLATFORM_TOOLSET v143 pin. Hard-coding the toolset breaks other supported VS versions; the cpprestsdk build fix belongs in the port overlay (2.10.19), not a forced toolset. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

florelis · 2026-07-16T20:22:53Z

/azp run

azure-pipelines · 2026-07-16T20:23:03Z

Azure Pipelines: Successfully started running 1 pipeline(s).

shmuelie requested a review from a team as a code owner July 6, 2026 21:44

florelis reviewed Jul 15, 2026

View reviewed changes

Comment thread src/AppInstallerCommonCore/AppInstallerTelemetry.cpp Outdated

Comment thread src/AppInstallerCommonCore/AppInstallerTelemetry.cpp Outdated

florelis requested a review from Copilot July 15, 2026 21:35

Copilot started reviewing on behalf of florelis July 15, 2026 21:36 View session

florelis reviewed Jul 15, 2026

View reviewed changes

Copilot AI reviewed Jul 15, 2026

View reviewed changes

Comment thread src/VcpkgCustomTriplets/common.cmake Outdated

Comment thread src/AppInstallerCLICore/Workflows/InstallFlow.cpp

shmuelie and others added 11 commits July 15, 2026 17:52

Force v143 tooling

28a63dc

Add store telemetry provider

60c4618

A method to send StoreExperienceTelemetryWinGetInstall telemetry event

08d8b20

Fix tracelog provider

f9d1bbd

Fix telemetry setup and sending

d9ae4fe

Send telemetry when from the store

2fba84d

Fix keyword

f67dcb8

Add more comments

cc5178d

Should use the Microsoft-Windows-Store provider, not the Microsoft.St…

4aaf552

…ore provider

shmuelie force-pushed the user/senglard/Feature6317 branch from 10cbff4 to 282167a Compare July 16, 2026 00:52

florelis approved these changes Jul 16, 2026

View reviewed changes

florelis merged commit b042bf9 into microsoft:master Jul 17, 2026
9 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Optional Telemetry Event for Microsoft Store Catalog Installs (msstore Source)#6352

Optional Telemetry Event for Microsoft Store Catalog Installs (msstore Source)#6352
florelis merged 11 commits into
microsoft:masterfrom
shmuelie:user/senglard/Feature6317

shmuelie commented Jul 6, 2026 •

edited by microsoft-github-policy-service Bot

Loading

Uh oh!

Uh oh!

Uh oh!

florelis Jul 15, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

florelis commented Jul 16, 2026

Uh oh!

azure-pipelines Bot commented Jul 16, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

shmuelie commented Jul 6, 2026 • edited by microsoft-github-policy-service Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📖 Description

Files changed

🔗 References

🔍 Validation

✅ Checklist

📋 Issue Type

Microsoft Reviewers: Open in CodeFlow

Uh oh!

Uh oh!

Uh oh!

florelis Jul 15, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

florelis commented Jul 16, 2026

Uh oh!

azure-pipelines Bot commented Jul 16, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

shmuelie commented Jul 6, 2026 •

edited by microsoft-github-policy-service Bot

Loading