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

src/AppInstallerCLICore/Workflows/InstallFlow.cpp

@@ -571,6 +571,17 @@ namespace AppInstaller::CLI::Workflow
         }
         else
         {
+            if (context.Contains(Execution::Data::PackageVersion))
+            {
+                const auto& packageVersion = context.Get<Execution::Data::PackageVersion>();
+
+                if (packageVersion && packageVersion->GetSource().IsWellKnownSource(WellKnownSource::MicrosoftStore))
+                {
+                    const auto& manifest = context.Get<Execution::Data::Manifest>();
+                    Logging::Telemetry().LogStoreInstall(manifest.Id);
+                }
+            }
+
             if (isRepair)
             {
                 context.Reporter.Info() << Resource::String::RepairFlowRepairSuccess << std::endl;

src/AppInstallerCommonCore/AppInstallerTelemetry.cpp

@@ -837,13 +837,29 @@ namespace AppInstaller::Logging
                 m_summary.PackageVersion = version;
                 m_summary.RepairExecutionType = type;
                 m_summary.RepairErrorCode = errorCode;
-            
+
             }
         }
 
         AICLI_LOG(CLI, Error, << type << " repair failed: " << errorCode);
     }
 
+    void TelemetryTraceLogger::LogStoreInstall(std::string_view packageId) const noexcept
+    {
+        // Don't use IsTelemetryEnabled as that also checks the WinGet provider.
+        if (g_IsStoreTelemetryProviderEnabled && m_isInitialized && m_isSettingEnabled && m_isRuntimeEnabled)
+        {
+            TraceLoggingWrite(g_hWindowsStoreProvider,
+                "StoreExperienceTelemetry-WinGetInstall",
+                TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
+                TraceLoggingKeyword(MICROSOFT_KEYWORD_CRITICAL_DATA),
+                AICLI_TraceLoggingStringView(packageId, "pid"),
+                TraceLoggingString(m_caller.c_str(), "src"),
+                TraceLoggingWideString(L"msstore", "cn")
+            );
+        }
+    }
+
     TelemetryTraceLogger::~TelemetryTraceLogger()
     {
         if (IsTelemetryEnabled())

src/AppInstallerCommonCore/Public/AppInstallerTelemetry.h

@@ -290,6 +290,9 @@ namespace AppInstaller::Logging
             uint64_t downloadedBytes,
             bool isManualUpdate) const noexcept;
 
+        // Logs when an install succeeded from the msstore source.
+        void LogStoreInstall(std::string_view packageId) const noexcept;
+
     protected:
         bool IsTelemetryEnabled() const noexcept;
 

src/AppInstallerCommonCore/Telemetry/TraceLogging.cpp

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 #include "pch.h"
@@ -15,6 +15,15 @@ bool g_IsTelemetryProviderEnabled{};
 UCHAR g_TelemetryProviderLevel{};
 ULONGLONG g_TelemetryProviderMatchAnyKeyword{};
 
+// GUID for Microsoft-Windows-Store : {9C2A37F3-E5FD-5CAE-BCD1-43DAFEEE1FF0}
+TRACELOGGING_DEFINE_PROVIDER(
+    g_hWindowsStoreProvider,
+    "Microsoft-Windows-Store",
+    (0x9c2a37f3, 0xe5fd, 0x5cae, 0xbc, 0xd1, 0x43, 0xda, 0xfe, 0xee, 0x1f, 0xf0),
+    TraceLoggingOptionMicrosoftTelemetry());
+
+bool g_IsStoreTelemetryProviderEnabled{};
+
 struct TraceProvider
 {
     TraceProvider();
@@ -38,12 +47,26 @@ void WINAPI TelemetryProviderEnabledCallback(
     g_TelemetryProviderMatchAnyKeyword = matchAnyKeyword;
 }
 
+void WINAPI StoreTelemetryProviderEnabledCallback(
+    _In_      LPCGUID /*sourceId*/,
+    _In_      ULONG isEnabled,
+    _In_      UCHAR /*level*/,
+    _In_      ULONGLONG /*matchAnyKeyword*/,
+    _In_      ULONGLONG /*matchAllKeywords*/,
+    _In_opt_  PEVENT_FILTER_DESCRIPTOR /*filterData*/,
+    _In_opt_  PVOID /*callbackContext*/)
+{
+    g_IsStoreTelemetryProviderEnabled = !!isEnabled;
+}
+
 TraceProvider::TraceProvider()
 {
     TraceLoggingRegisterEx(g_hTraceProvider, TelemetryProviderEnabledCallback, nullptr);
+    TraceLoggingRegisterEx(g_hWindowsStoreProvider, StoreTelemetryProviderEnabledCallback, nullptr);
 }
 
 TraceProvider::~TraceProvider()
 {
     TraceLoggingUnregister(g_hTraceProvider);
+    TraceLoggingUnregister(g_hWindowsStoreProvider);
 }

src/AppInstallerCommonCore/Telemetry/TraceLogging.h

@@ -1,4 +1,4 @@
-// Copyright (c) Microsoft Corporation. All rights reserved.
+// Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
 
 #pragma once
@@ -63,4 +63,7 @@
 TRACELOGGING_DECLARE_PROVIDER(g_hTraceProvider);
 extern bool g_IsTelemetryProviderEnabled;
 extern UCHAR g_TelemetryProviderLevel;
-extern ULONGLONG g_TelemetryProviderMatchAnyKeyword;
+extern ULONGLONG g_TelemetryProviderMatchAnyKeyword;
+
+TRACELOGGING_DECLARE_PROVIDER(g_hWindowsStoreProvider);
+extern bool g_IsStoreTelemetryProviderEnabled;