Mirrors/PowerToys
1
0
Fork 0
mirror of https://github.com/microsoft/PowerToys.git synced 2026-02-24 04:00:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

[General]Add an option for telemetry opt-in and visualization(#34078)

Browse Source 
* Data diagnostics opt-in

* [c++] Drop DROP_PII flag

* Bump telemtry package to 2.0.2

* Drop DropPii from custom actions

* Cleanup

* Do not start manually C# EtwTrace. FZ engine exit event.

* ImageResizer, PowerRename, FileLocksmith prev handlers

* Revert C# handlers exe logging

* Revert "Revert C# handlers exe logging"

This reverts commit 4c75a3953b.

* Do not recreate EtwTrace

* consume package

* xaml formatting

* Fix deps.json audit

* Update telem package paths

* Address PR comments

* Fix AdvancedPaste close on PT close

* Override etl file name for explorer loaded dlls
Start/stop tracer when needed for explorer loaded dlls to prevent explorer overload

* Fix setting desc

* Fix missing events

* Add infobar to restart when enable data viewing

* Flush on timer every 30s

* [Settings] Update View Data diagnostic description text
[New+] Add tracer

* Show Restart info bar for both enable/disable data viewer

* Fix newplus

* Fix stuck on restart and terminate AdvPaste exe on destroy()

* [Installer] Add tracer

* Address PR comment

* Add missing tracers

* Exclude etw dir from BugReport

* Fix bad merge

* [Hosts] Proper exit on initial dialog

* [OOBE] Make Data diagnostic setting visible without scroll

* [OOBE] Add hiperlynk to open general settings

* Disable data view on disabling data diagnostics

* Don't disable View data button

* Fix disabling data viewing

* Add missing dot

* Revert formatting
This commit is contained in:
Stefan Markovic
2024-10-24 22:04:32 +02:00
committed by GitHub
parent f9127b63a5
commit 133aa85f2b
269 changed files with 2622 additions and 1256 deletions
Download Patch File Download Diff File Expand all files Collapse all files

118
src/modules/keyboardmanager/KeyboardManagerEngineLibrary/trace.cpp
View File

@@ -2,6 +2,8 @@
#include "trace.h"
#include <common/interop/keyboard_layout.h>
#include <common/Telemetry/TraceBase.h>
TRACELOGGING_DEFINE_PROVIDER(
g_hProvider,
"Microsoft.PowerToys",
@@ -9,74 +11,64 @@ TRACELOGGING_DEFINE_PROVIDER(
(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 a key to key remap has been invoked today.
void Trace::DailyKeyToKeyRemapInvoked() noexcept
{
TraceLoggingWrite(
g_hProvider,
"KeyboardManager_DailyKeyToKeyRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_DailyKeyToKeyRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
}
// Log if a key to shortcut remap has been invoked today.
void Trace::DailyKeyToShortcutRemapInvoked() noexcept
{
TraceLoggingWrite(
g_hProvider,
"KeyboardManager_DailyKeyToShortcutRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_DailyKeyToShortcutRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
}
// Log if a shortcut to key remap has been invoked today.
void Trace::DailyShortcutToKeyRemapInvoked() noexcept
{
TraceLoggingWrite(
g_hProvider,
"KeyboardManager_DailyShortcutToKeyRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_DailyShortcutToKeyRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
}
// Log if a shortcut to shortcut remap has been invoked today.
void Trace::DailyShortcutToShortcutRemapInvoked() noexcept
{
TraceLoggingWrite(
g_hProvider,
"KeyboardManager_DailyShortcutToShortcutRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_DailyShortcutToShortcutRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
}
// Log if an app specific shortcut to key remap has been invoked today.
void Trace::DailyAppSpecificShortcutToKeyRemapInvoked() noexcept
{
TraceLoggingWrite(
g_hProvider,
"KeyboardManager_DailyAppSpecificShortcutToKeyRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_DailyAppSpecificShortcutToKeyRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
}
// Log if an app specific shortcut to shortcut remap has been invoked today.
void Trace::DailyAppSpecificShortcutToShortcutRemapInvoked() noexcept
{
TraceLoggingWrite(
g_hProvider,
"KeyboardManager_DailyAppSpecificShortcutToShortcutRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_DailyAppSpecificShortcutToShortcutRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
}
// Log if a key remap has been invoked (not being used currently, due to being garrulous)
@@ -84,7 +76,7 @@ void Trace::KeyRemapInvoked(bool isKeyToKey) noexcept
{
if (isKeyToKey)
{
TraceLoggingWrite(
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_KeyToKeyRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -92,7 +84,7 @@ void Trace::KeyRemapInvoked(bool isKeyToKey) noexcept
}
else
{
TraceLoggingWrite(
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_KeyToShortcutRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -107,7 +99,7 @@ void Trace::ShortcutRemapInvoked(bool isShortcutToShortcut, bool isAppSpecific)
{
if (isShortcutToShortcut)
{
TraceLoggingWrite(
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_AppSpecificShortcutToShortcutRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -115,7 +107,7 @@ void Trace::ShortcutRemapInvoked(bool isShortcutToShortcut, bool isAppSpecific)
}
else
{
TraceLoggingWrite(
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_AppSpecificShortcutToKeyRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -126,7 +118,7 @@ void Trace::ShortcutRemapInvoked(bool isShortcutToShortcut, bool isAppSpecific)
{
if (isShortcutToShortcut)
{
TraceLoggingWrite(
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_OSLevelShortcutToShortcutRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -134,7 +126,7 @@ void Trace::ShortcutRemapInvoked(bool isShortcutToShortcut, bool isAppSpecific)
}
else
{
TraceLoggingWrite(
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_OSLevelShortcutToKeyRemapInvoked",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -144,7 +136,7 @@ void Trace::ShortcutRemapInvoked(bool isShortcutToShortcut, bool isAppSpecific)
}
// Function to return a human readable string for the shortcut
std::wstring GetShortcutHumanReadableString(Shortcut const & shortcut, LayoutMap& keyboardMap)
std::wstring GetShortcutHumanReadableString(Shortcut const& shortcut, LayoutMap& keyboardMap)
{
std::wstring humanReadableShortcut = L"";
if (shortcut.winKey != ModifierKey::Disabled)
@@ -184,7 +176,7 @@ void Trace::SendKeyAndShortcutRemapLoadedConfiguration(State& remappings) noexce
if (keyRemap.second.index() == 0) // 0 - Remapping to key
{
DWORD keyRemappedTo = std::get<DWORD>(keyRemap.second);
TraceLoggingWrite(
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_KeyRemapConfigurationLoaded",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -192,13 +184,12 @@ void Trace::SendKeyAndShortcutRemapLoadedConfiguration(State& remappings) noexce
TraceLoggingInt64(keyRemap.first, "KeyRemapFrom"),
TraceLoggingInt64(keyRemappedTo, "KeyRemapTo"),
TraceLoggingWideString(keyboardMap.GetKeyName(keyRemap.first).c_str(), "HumanRemapFrom"),
TraceLoggingWideString(keyboardMap.GetKeyName(keyRemappedTo).c_str(), "HumanRemapTo")
);
TraceLoggingWideString(keyboardMap.GetKeyName(keyRemappedTo).c_str(), "HumanRemapTo"));
}
else if (keyRemap.second.index() == 1) // 1 - Remapping to shortcut
{
Shortcut shortcutRemappedTo = std::get<Shortcut>(keyRemap.second);
TraceLoggingWrite(
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_KeyRemapConfigurationLoaded",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -210,8 +201,7 @@ void Trace::SendKeyAndShortcutRemapLoadedConfiguration(State& remappings) noexce
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedTo.altKey), "ModifierRemapToAlt"),
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedTo.shiftKey), "ModifierRemapToShift"),
TraceLoggingWideString(keyboardMap.GetKeyName(keyRemap.first).c_str(), "HumanRemapFrom"),
TraceLoggingWideString(GetShortcutHumanReadableString(shortcutRemappedTo, keyboardMap).c_str(), "HumanRemapTo")
);
TraceLoggingWideString(GetShortcutHumanReadableString(shortcutRemappedTo, keyboardMap).c_str(), "HumanRemapTo"));
}
}
@@ -221,7 +211,7 @@ void Trace::SendKeyAndShortcutRemapLoadedConfiguration(State& remappings) noexce
if (shortcutRemap.second.targetShortcut.index() == 0) // 0 - Remapping to key
{
DWORD keyRemappedTo = std::get<DWORD>(shortcutRemap.second.targetShortcut);
TraceLoggingWrite(
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_ShortcutRemapConfigurationLoaded",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -245,7 +235,7 @@ void Trace::SendKeyAndShortcutRemapLoadedConfiguration(State& remappings) noexce
// Don't include Start app or Open URI mappings in this telemetry.
continue;
}
TraceLoggingWrite(
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_ShortcutRemapConfigurationLoaded",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -263,8 +253,7 @@ void Trace::SendKeyAndShortcutRemapLoadedConfiguration(State& remappings) noexce
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedTo.altKey), "ModifierRemapToAlt"),
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedTo.shiftKey), "ModifierRemapToShift"),
TraceLoggingWideString(GetShortcutHumanReadableString(shortcutRemappedFrom, keyboardMap).c_str(), "HumanRemapFrom"),
TraceLoggingWideString(GetShortcutHumanReadableString(shortcutRemappedTo, keyboardMap).c_str(), "HumanRemapTo")
);
TraceLoggingWideString(GetShortcutHumanReadableString(shortcutRemappedTo, keyboardMap).c_str(), "HumanRemapTo"));
}
}
@@ -277,7 +266,7 @@ void Trace::SendKeyAndShortcutRemapLoadedConfiguration(State& remappings) noexce
if (shortcutRemap.second.targetShortcut.index() == 0) // 0 - Remapping to key
{
DWORD keyRemappedTo = std::get<DWORD>(shortcutRemap.second.targetShortcut);
TraceLoggingWrite(
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_AppSpecificShortcutRemapConfigurationLoaded",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -292,8 +281,7 @@ void Trace::SendKeyAndShortcutRemapLoadedConfiguration(State& remappings) noexce
TraceLoggingInt64(keyRemappedTo, "KeyRemapTo"),
TraceLoggingWideString(GetShortcutHumanReadableString(shortcutRemappedFrom, keyboardMap).c_str(), "HumanRemapFrom"),
TraceLoggingWideString(keyboardMap.GetKeyName(keyRemappedTo).c_str(), "HumanRemapTo"),
TraceLoggingWideString(appName.c_str(), "TargetApp")
);
TraceLoggingWideString(appName.c_str(), "TargetApp"));
}
else if (shortcutRemap.second.targetShortcut.index() == 1) // 1 - Remapping to shortcut
{
@@ -303,7 +291,7 @@ void Trace::SendKeyAndShortcutRemapLoadedConfiguration(State& remappings) noexce
// Don't include Start app or Open URI mappings in this telemetry.
continue;
}
TraceLoggingWrite(
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_AppSpecificShortcutRemapConfigurationLoaded",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
@@ -322,8 +310,7 @@ void Trace::SendKeyAndShortcutRemapLoadedConfiguration(State& remappings) noexce
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedTo.shiftKey), "ModifierRemapToShift"),
TraceLoggingWideString(GetShortcutHumanReadableString(shortcutRemappedFrom, keyboardMap).c_str(), "HumanRemapFrom"),
TraceLoggingWideString(GetShortcutHumanReadableString(shortcutRemappedTo, keyboardMap).c_str(), "HumanRemapTo"),
TraceLoggingWideString(appName.c_str(), "TargetApp")
);
TraceLoggingWideString(appName.c_str(), "TargetApp"));
}
}
}
@@ -332,18 +319,17 @@ void Trace::SendKeyAndShortcutRemapLoadedConfiguration(State& remappings) noexce
// Log an error while trying to send remappings telemetry.
void Trace::ErrorSendingKeyAndShortcutRemapLoadedConfiguration() noexcept
{
TraceLoggingWrite(
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_ErrorSendingKeyAndShortcutRemapLoadedConfiguration",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
}
// Log if an error occurs in KBM
void Trace::Error(const DWORD errorCode, std::wstring errorMessage, std::wstring methodName) noexcept
{
TraceLoggingWrite(
TraceLoggingWriteWrapper(
g_hProvider,
"KeyboardManager_Error",
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),