Added telemetry to KBM (#2670)

* Added telemetry to KBM

* Reverted set_config change

* resolving comments

src/modules/keyboardmanager/common/KeyboardManagerCommon.vcxproj

@@ -100,6 +100,7 @@
     </ClCompile>
     <ClCompile Include="RemapShortcut.cpp" />
     <ClCompile Include="Shortcut.cpp" />
+    <ClCompile Include="trace.cpp" />
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="Helpers.h" />
@@ -109,6 +110,7 @@
     <ClInclude Include="pch.h" />
     <ClInclude Include="RemapShortcut.h" />
     <ClInclude Include="Shortcut.h" />
+    <ClInclude Include="trace.h" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\..\..\common\common.vcxproj">

src/modules/keyboardmanager/common/KeyboardManagerCommon.vcxproj.filters

@@ -33,6 +33,9 @@
     <ClCompile Include="KeyDelay.cpp">
       <Filter>Source Files</Filter>
     </ClCompile>
+    <ClCompile Include="Trace.cpp">
+      <Filter>Source Files</Filter>
+    </ClCompile>
   </ItemGroup>
   <ItemGroup>
     <ClInclude Include="KeyboardManagerState.h">
@@ -56,5 +59,8 @@
     <ClInclude Include="KeyboardManagerConstants.h">
       <Filter>Header Files</Filter>
     </ClInclude>
+    <ClInclude Include="Trace.h">
+      <Filter>Header Files</Filter>
+    </ClInclude>
   </ItemGroup>
 </Project>

src/modules/keyboardmanager/common/pch.h

@@ -13,6 +13,7 @@
 #include "winrt/Windows.UI.Text.h"
 #include "winrt/Windows.UI.Core.h"
 #include <stdlib.h>
+#include <ProjectTelemetry.h>
 
 using namespace winrt;
 using namespace Windows::UI;

src/modules/keyboardmanager/common/trace.cpp

@@ -0,0 +1,52 @@
+#include "pch.h"
+#include "trace.h"
+
+TRACELOGGING_DEFINE_PROVIDER(
+    g_hProvider,
+    "Microsoft.PowerToys",
+    // {38e8889b-9731-53f5-e901-e8a7c1753074}
+    (0x38e8889b, 0x9731, 0x53f5, 0xe9, 0x01, 0xe8, 0xa7, 0xc1, 0x75, 0x30, 0x74),
+    TraceLoggingOptionProjectTelemetry());
+
+void Trace::RegisterProvider() noexcept
+{
+    TraceLoggingRegister(g_hProvider);
+}
+
+void Trace::UnregisterProvider() noexcept
+{
+    TraceLoggingUnregister(g_hProvider);
+}
+
+// Log if the user has KBM enabled or disabled - Can also be used to see how often users have to restart the keyboard hook
+void Trace::EnableKeyboardManager(const bool enabled) noexcept
+{
+    TraceLoggingWrite(
+        g_hProvider,
+        "KeyboardManager_EnableKeyboardManager",
+        ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
+        TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
+        TraceLoggingBoolean(enabled, "Enabled"));
+}
+
+// Log number of key remaps when the user uses Edit Keyboard and saves settings
+void Trace::KeyRemapCount(const DWORD count) noexcept
+{
+    TraceLoggingWrite(
+        g_hProvider,
+        "KeyboardManager_KeyRemapCount",
+        ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
+        TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
+        TraceLoggingValue(count, "KeyRemapCount"));
+}
+
+// Log number of os level shortcut remaps when the user uses Edit Shortcuts and saves settings
+void Trace::OSLevelShortcutRemapCount(const DWORD count) noexcept
+{
+    TraceLoggingWrite(
+        g_hProvider,
+        "KeyboardManager_OSLevelShortcutRemapCount",
+        ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
+        TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
+        TraceLoggingValue(count, "OSLevelShortcutRemapCount"));
+}

src/modules/keyboardmanager/common/trace.h

@@ -0,0 +1,17 @@
+#pragma once
+
+class Trace
+{
+public:
+    static void RegisterProvider() noexcept;
+    static void UnregisterProvider() noexcept;
+
+    // Log if the user has KBM enabled or disabled - Can also be used to see how often users have to restart the keyboard hook
+    static void EnableKeyboardManager(const bool enabled) noexcept;
+
+    // Log number of key remaps when the user uses Edit Keyboard and saves settings
+    static void KeyRemapCount(const DWORD count) noexcept;
+
+    // Log number of os level shortcut remaps when the user uses Edit Shortcuts and saves settings
+    static void OSLevelShortcutRemapCount(const DWORD count) noexcept;
+};