mirror of
https://github.com/microsoft/PowerToys.git
synced 2026-02-23 19:49:43 +01:00
133aa85f2b
* 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
341 lines
17 KiB
C++
341 lines
17 KiB
C++
#include "pch.h"
|
|
#include "trace.h"
|
|
#include <common/interop/keyboard_layout.h>
|
|
|
|
#include <common/Telemetry/TraceBase.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());
|
|
|
|
// Log if a key to key remap has been invoked today.
|
|
void Trace::DailyKeyToKeyRemapInvoked() noexcept
|
|
{
|
|
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
|
|
{
|
|
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
|
|
{
|
|
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
|
|
{
|
|
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
|
|
{
|
|
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
|
|
{
|
|
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)
|
|
void Trace::KeyRemapInvoked(bool isKeyToKey) noexcept
|
|
{
|
|
if (isKeyToKey)
|
|
{
|
|
TraceLoggingWriteWrapper(
|
|
g_hProvider,
|
|
"KeyboardManager_KeyToKeyRemapInvoked",
|
|
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
|
|
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
|
|
}
|
|
else
|
|
{
|
|
TraceLoggingWriteWrapper(
|
|
g_hProvider,
|
|
"KeyboardManager_KeyToShortcutRemapInvoked",
|
|
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
|
|
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
|
|
}
|
|
}
|
|
|
|
// Log if a shortcut remap has been invoked (not being used currently, due to being garrulous)
|
|
void Trace::ShortcutRemapInvoked(bool isShortcutToShortcut, bool isAppSpecific) noexcept
|
|
{
|
|
if (isAppSpecific)
|
|
{
|
|
if (isShortcutToShortcut)
|
|
{
|
|
TraceLoggingWriteWrapper(
|
|
g_hProvider,
|
|
"KeyboardManager_AppSpecificShortcutToShortcutRemapInvoked",
|
|
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
|
|
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
|
|
}
|
|
else
|
|
{
|
|
TraceLoggingWriteWrapper(
|
|
g_hProvider,
|
|
"KeyboardManager_AppSpecificShortcutToKeyRemapInvoked",
|
|
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
|
|
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if (isShortcutToShortcut)
|
|
{
|
|
TraceLoggingWriteWrapper(
|
|
g_hProvider,
|
|
"KeyboardManager_OSLevelShortcutToShortcutRemapInvoked",
|
|
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
|
|
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
|
|
}
|
|
else
|
|
{
|
|
TraceLoggingWriteWrapper(
|
|
g_hProvider,
|
|
"KeyboardManager_OSLevelShortcutToKeyRemapInvoked",
|
|
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
|
|
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE));
|
|
}
|
|
}
|
|
}
|
|
|
|
// Function to return a human readable string for the shortcut
|
|
std::wstring GetShortcutHumanReadableString(Shortcut const& shortcut, LayoutMap& keyboardMap)
|
|
{
|
|
std::wstring humanReadableShortcut = L"";
|
|
if (shortcut.winKey != ModifierKey::Disabled)
|
|
{
|
|
humanReadableShortcut += keyboardMap.GetKeyName(shortcut.GetWinKey(ModifierKey::Both)) + L" + ";
|
|
}
|
|
if (shortcut.ctrlKey != ModifierKey::Disabled)
|
|
{
|
|
humanReadableShortcut += keyboardMap.GetKeyName(shortcut.GetCtrlKey()) + L" + ";
|
|
}
|
|
if (shortcut.altKey != ModifierKey::Disabled)
|
|
{
|
|
humanReadableShortcut += keyboardMap.GetKeyName(shortcut.GetAltKey()) + L" + ";
|
|
}
|
|
if (shortcut.shiftKey != ModifierKey::Disabled)
|
|
{
|
|
humanReadableShortcut += keyboardMap.GetKeyName(shortcut.GetShiftKey()) + L" + ";
|
|
}
|
|
if (shortcut.actionKey != NULL)
|
|
{
|
|
humanReadableShortcut += keyboardMap.GetKeyName(shortcut.actionKey);
|
|
if (shortcut.secondKey != NULL)
|
|
{
|
|
humanReadableShortcut += L" , " + keyboardMap.GetKeyName(shortcut.secondKey);
|
|
}
|
|
}
|
|
return humanReadableShortcut;
|
|
}
|
|
|
|
|
|
// Log the current remappings of key and shortcuts when keyboard manager engine loads the settings.
|
|
void Trace::SendKeyAndShortcutRemapLoadedConfiguration(State& remappings) noexcept
|
|
{
|
|
LayoutMap keyboardMap;
|
|
for (auto const& keyRemap : remappings.singleKeyReMap)
|
|
{
|
|
if (keyRemap.second.index() == 0) // 0 - Remapping to key
|
|
{
|
|
DWORD keyRemappedTo = std::get<DWORD>(keyRemap.second);
|
|
TraceLoggingWriteWrapper(
|
|
g_hProvider,
|
|
"KeyboardManager_KeyRemapConfigurationLoaded",
|
|
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
|
|
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
|
|
TraceLoggingInt64(keyRemap.first, "KeyRemapFrom"),
|
|
TraceLoggingInt64(keyRemappedTo, "KeyRemapTo"),
|
|
TraceLoggingWideString(keyboardMap.GetKeyName(keyRemap.first).c_str(), "HumanRemapFrom"),
|
|
TraceLoggingWideString(keyboardMap.GetKeyName(keyRemappedTo).c_str(), "HumanRemapTo"));
|
|
}
|
|
else if (keyRemap.second.index() == 1) // 1 - Remapping to shortcut
|
|
{
|
|
Shortcut shortcutRemappedTo = std::get<Shortcut>(keyRemap.second);
|
|
TraceLoggingWriteWrapper(
|
|
g_hProvider,
|
|
"KeyboardManager_KeyRemapConfigurationLoaded",
|
|
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
|
|
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
|
|
TraceLoggingInt64(keyRemap.first, "KeyRemapFrom"),
|
|
TraceLoggingInt64(shortcutRemappedTo.actionKey, "KeyRemapTo"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedTo.winKey), "ModifierRemapToWin"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedTo.ctrlKey), "ModifierRemapToCtrl"),
|
|
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"));
|
|
}
|
|
}
|
|
|
|
for (auto const& shortcutRemap : remappings.osLevelShortcutReMap)
|
|
{
|
|
Shortcut shortcutRemappedFrom = shortcutRemap.first;
|
|
if (shortcutRemap.second.targetShortcut.index() == 0) // 0 - Remapping to key
|
|
{
|
|
DWORD keyRemappedTo = std::get<DWORD>(shortcutRemap.second.targetShortcut);
|
|
TraceLoggingWriteWrapper(
|
|
g_hProvider,
|
|
"KeyboardManager_ShortcutRemapConfigurationLoaded",
|
|
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
|
|
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
|
|
TraceLoggingInt64(shortcutRemappedFrom.actionKey, "KeyRemapFrom"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedFrom.winKey), "ModifierRemapFromWin"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedFrom.ctrlKey), "ModifierRemapFromCtrl"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedFrom.altKey), "ModifierRemapFromAlt"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedFrom.shiftKey), "ModifierRemapFromShift"),
|
|
TraceLoggingBool(shortcutRemappedFrom.HasChord(), "KeyRemapFromHasChord"),
|
|
TraceLoggingInt64(shortcutRemappedFrom.secondKey, "KeyRemapFromChordSecondKey"),
|
|
TraceLoggingInt64(keyRemappedTo, "KeyRemapTo"),
|
|
TraceLoggingWideString(GetShortcutHumanReadableString(shortcutRemappedFrom, keyboardMap).c_str(), "HumanRemapFrom"),
|
|
TraceLoggingWideString(keyboardMap.GetKeyName(keyRemappedTo).c_str(), "HumanRemapTo"));
|
|
}
|
|
else if (shortcutRemap.second.targetShortcut.index() == 1) // 1 - Remapping to shortcut
|
|
{
|
|
Shortcut shortcutRemappedTo = std::get<Shortcut>(shortcutRemap.second.targetShortcut);
|
|
if (shortcutRemappedTo.IsRunProgram() || shortcutRemappedTo.IsOpenURI())
|
|
{
|
|
// Don't include Start app or Open URI mappings in this telemetry.
|
|
continue;
|
|
}
|
|
TraceLoggingWriteWrapper(
|
|
g_hProvider,
|
|
"KeyboardManager_ShortcutRemapConfigurationLoaded",
|
|
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
|
|
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
|
|
TraceLoggingInt64(shortcutRemappedFrom.actionKey, "KeyRemapFrom"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedFrom.winKey), "ModifierRemapFromWin"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedFrom.ctrlKey), "ModifierRemapFromCtrl"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedFrom.altKey), "ModifierRemapFromAlt"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedFrom.shiftKey), "ModifierRemapFromShift"),
|
|
TraceLoggingBool(shortcutRemappedFrom.HasChord(), "KeyRemapFromHasChord"),
|
|
TraceLoggingInt64(shortcutRemappedFrom.secondKey, "KeyRemapFromChordSecondKey"),
|
|
TraceLoggingInt64(shortcutRemappedTo.actionKey, "KeyRemapTo"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedTo.winKey), "ModifierRemapToWin"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedTo.ctrlKey), "ModifierRemapToCtrl"),
|
|
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"));
|
|
}
|
|
}
|
|
|
|
for (auto const& appShortcutRemap : remappings.appSpecificShortcutReMap)
|
|
{
|
|
std::wstring appName = appShortcutRemap.first;
|
|
for (auto const& shortcutRemap : appShortcutRemap.second)
|
|
{
|
|
Shortcut shortcutRemappedFrom = shortcutRemap.first;
|
|
if (shortcutRemap.second.targetShortcut.index() == 0) // 0 - Remapping to key
|
|
{
|
|
DWORD keyRemappedTo = std::get<DWORD>(shortcutRemap.second.targetShortcut);
|
|
TraceLoggingWriteWrapper(
|
|
g_hProvider,
|
|
"KeyboardManager_AppSpecificShortcutRemapConfigurationLoaded",
|
|
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
|
|
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
|
|
TraceLoggingInt64(shortcutRemappedFrom.actionKey, "KeyRemapFrom"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedFrom.winKey), "ModifierRemapFromWin"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedFrom.ctrlKey), "ModifierRemapFromCtrl"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedFrom.altKey), "ModifierRemapFromAlt"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedFrom.shiftKey), "ModifierRemapFromShift"),
|
|
TraceLoggingBool(shortcutRemappedFrom.HasChord(), "KeyRemapFromHasChord"),
|
|
TraceLoggingInt64(shortcutRemappedFrom.secondKey, "KeyRemapFromChordSecondKey"),
|
|
TraceLoggingInt64(keyRemappedTo, "KeyRemapTo"),
|
|
TraceLoggingWideString(GetShortcutHumanReadableString(shortcutRemappedFrom, keyboardMap).c_str(), "HumanRemapFrom"),
|
|
TraceLoggingWideString(keyboardMap.GetKeyName(keyRemappedTo).c_str(), "HumanRemapTo"),
|
|
TraceLoggingWideString(appName.c_str(), "TargetApp"));
|
|
}
|
|
else if (shortcutRemap.second.targetShortcut.index() == 1) // 1 - Remapping to shortcut
|
|
{
|
|
Shortcut shortcutRemappedTo = std::get<Shortcut>(shortcutRemap.second.targetShortcut);
|
|
if (shortcutRemappedTo.IsRunProgram() || shortcutRemappedTo.IsOpenURI())
|
|
{
|
|
// Don't include Start app or Open URI mappings in this telemetry.
|
|
continue;
|
|
}
|
|
TraceLoggingWriteWrapper(
|
|
g_hProvider,
|
|
"KeyboardManager_AppSpecificShortcutRemapConfigurationLoaded",
|
|
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
|
|
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
|
|
TraceLoggingInt64(shortcutRemappedFrom.actionKey, "KeyRemapFrom"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedFrom.winKey), "ModifierRemapFromWin"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedFrom.ctrlKey), "ModifierRemapFromCtrl"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedFrom.altKey), "ModifierRemapFromAlt"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedFrom.shiftKey), "ModifierRemapFromShift"),
|
|
TraceLoggingBool(shortcutRemappedFrom.HasChord(), "KeyRemapFromHasChord"),
|
|
TraceLoggingInt64(shortcutRemappedFrom.secondKey, "KeyRemapFromChordSecondKey"),
|
|
TraceLoggingInt64(shortcutRemappedTo.actionKey, "KeyRemapTo"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedTo.winKey), "ModifierRemapToWin"),
|
|
TraceLoggingInt8(static_cast<INT8>(shortcutRemappedTo.ctrlKey), "ModifierRemapToCtrl"),
|
|
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(appName.c_str(), "TargetApp"));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Log an error while trying to send remappings telemetry.
|
|
void Trace::ErrorSendingKeyAndShortcutRemapLoadedConfiguration() noexcept
|
|
{
|
|
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
|
|
{
|
|
TraceLoggingWriteWrapper(
|
|
g_hProvider,
|
|
"KeyboardManager_Error",
|
|
ProjectTelemetryPrivacyDataTag(ProjectTelemetryTag_ProductAndServicePerformance),
|
|
TraceLoggingKeyword(PROJECT_KEYWORD_MEASURE),
|
|
TraceLoggingValue(methodName.c_str(), "MethodName"),
|
|
TraceLoggingValue(errorCode, "ErrorCode"),
|
|
TraceLoggingValue(errorMessage.c_str(), "ErrorMessage"));
|
|
}
|