Skip to content

Improve TraceLogging #5407

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 9 commits into from
Closed

Improve TraceLogging #5407

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d7132c0
Added missing PDT
DrusTheAxe Mar 27, 2025
e01c7c7
_GENERIC_PARTB_FIELDS_ENABLED adds only
AgneLukoseviciute Jun 9, 2025
22aaa21
including partb in writeeventwithactivity
AgneLukoseviciute Jun 10, 2025
86aa80c
confirming writeeventwithactivity changes is what breaks
AgneLukoseviciute Jun 11, 2025
c10faf3
isolate changes
AgneLukoseviciute Jun 16, 2025
b16e507
just _WRITE_FAILURE_INFO refactor
AgneLukoseviciute Jun 16, 2025
090a942
partb
AgneLukoseviciute Jun 17, 2025
fd803cc
done
AgneLukoseviciute Jun 17, 2025
fb2781d
use static version defines
AgneLukoseviciute Jun 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions dev/Deployment/DeploymentTraceLogging.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ class WindowsAppRuntimeDeployment_TraceLogger final : public wil::TraceLoggingPr
TraceLoggingValue(isPackagedProcess, "isPackagedProcess"),
TraceLoggingValue(isFullTrustPackage, "isFullTrustPackage"),
TraceLoggingValue(integrityLevel, "integrityLevel"),
TraceLoggingValue(isRepair, "isRepairAPI"));
TraceLoggingValue(isRepair, "isRepairAPI"),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
}
void StopWithResult(
HRESULT hresult,
Expand Down Expand Up @@ -71,7 +72,8 @@ class WindowsAppRuntimeDeployment_TraceLogger final : public wil::TraceLoggingPr
TraceLoggingValue(deploymentErrorExtendedHResult, "DeploymentErrorExtendedHResult"),
TraceLoggingValue(deploymentErrorText, "DeploymentErrorText"),
TraceLoggingValue(deploymentErrorActivityId, "DeploymentErrorActivityId"),
TraceLoggingValue(useExistingPackageIfHigherVersion, "useExistingPackageIfHigherVersion"));
TraceLoggingValue(useExistingPackageIfHigherVersion, "useExistingPackageIfHigherVersion"),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
}
else
{
Expand Down Expand Up @@ -101,4 +103,5 @@ class WindowsAppRuntimeDeployment_TraceLogger final : public wil::TraceLoggingPr
TraceLoggingValue(failure.uLineNumber, "Line"),\
TraceLoggingValue(failure.pszMessage, "Message"),\
TraceLoggingValue(failure.pszModule, "Module"),\
_GENERIC_PARTB_FIELDS_ENABLED,\
__VA_ARGS__)
1 change: 0 additions & 1 deletion dev/Deployment/DeploymentTracelogging.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ void __stdcall wilResultLoggingCallback(const wil::FailureInfo& failure) noexcep
// Failure in restarting PushNotificationsLRP is non-blocking to the installer functionality
WindowsAppRuntimeDeployment_WriteEventWithActivity(
"RestartPushNotificationsLRPFailed",
_GENERIC_PARTB_FIELDS_ENABLED,
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingKeyword(MICROSOFT_KEYWORD_CRITICAL_DATA));
}
Expand Down
3 changes: 3 additions & 0 deletions dev/PackageManager/API/M.W.M.D.PackageDeploymentManager.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,7 @@ namespace winrt::Microsoft::Windows::Management::Deployment::implementation
TraceLoggingWideString(packageSetItem.PackageFamilyName().c_str(), "Criteria.PackageFamilyName"),
TraceLoggingHexUInt64(minVersion.Version, "Criteria.MinVersion"),
TraceLoggingHexInt32(static_cast<std::int32_t>(packageSetItem.ProcessorArchitectureFilter()), "Criteria.ArchitectureFilter"),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
return false;
Expand Down Expand Up @@ -351,6 +352,7 @@ namespace winrt::Microsoft::Windows::Management::Deployment::implementation
TraceLoggingHexUInt64(minVersion.Version, "Criteria.MinVersion"),
TraceLoggingHexInt32(static_cast<std::int32_t>(packageSetItem.ProcessorArchitectureFilter()), "Criteria.ArchitectureFilter"),
TraceLoggingInt32(static_cast<std::int32_t>(status), "PackageReadyOrNewerAvailableStatus"),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
return winrt::Microsoft::Windows::Management::Deployment::PackageReadyOrNewerAvailableStatus::NotReady;
Expand All @@ -366,6 +368,7 @@ namespace winrt::Microsoft::Windows::Management::Deployment::implementation
TraceLoggingHexUInt64(minVersion.Version, "Criteria.MinVersion"),
TraceLoggingHexInt32(static_cast<std::int32_t>(packageSetItem.ProcessorArchitectureFilter()), "Criteria.ArchitectureFilter"),
TraceLoggingInt32(static_cast<std::int32_t>(status), "PackageReadyOrNewerAvailableStatus"),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
newerAvailable = true;
Expand Down
8 changes: 8 additions & 0 deletions dev/PackageManager/API/PackageDeploymentResolver.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,7 @@ winrt::hstring Microsoft::Windows::ApplicationModel::PackageDeploymentResolver::
TraceLoggingWideString(packageFamilyName.c_str(), "Criteria.PackageFamilyName"),
TraceLoggingHexUInt64(minVersion.Version, "Criteria.MinVersion"),
TraceLoggingHexInt32(static_cast<std::int32_t>(processorArchitectureFilter), "Criteria.ArchitectureFilter"),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
if (packages)
Expand All @@ -212,6 +213,7 @@ winrt::hstring Microsoft::Windows::ApplicationModel::PackageDeploymentResolver::
TraceLoggingWideString(packageFamilyName.c_str(), "Criteria.PackageFamilyName"),
TraceLoggingHexUInt64(minVersion.Version, "Criteria.MinVersion"),
TraceLoggingHexInt32(static_cast<std::int32_t>(processorArchitectureFilter), "Criteria.ArchitectureFilter"),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
continue;
Expand Down Expand Up @@ -243,6 +245,7 @@ winrt::hstring Microsoft::Windows::ApplicationModel::PackageDeploymentResolver::
TraceLoggingInt32(static_cast<std::int32_t>(candidateArchitecture), "Architecture"),
TraceLoggingHexInt32(static_cast<std::int32_t>(supportedArchitectures), "SupportedArchitectures"),
TraceLoggingUInt16(static_cast<std::uint32_t>(nativeMachine), "NativeMachineArchitecture"),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
continue;
Expand All @@ -260,6 +263,7 @@ winrt::hstring Microsoft::Windows::ApplicationModel::PackageDeploymentResolver::
TraceLoggingHexUInt64(minVersion.Version, "Criteria.MinVersion"),
TraceLoggingHexInt32(static_cast<std::int32_t>(processorArchitectureFilter), "Criteria.ArchitectureFilter"),
TraceLoggingInt32(static_cast<std::int32_t>(candidateArchitecture), "Architecture"),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
continue;
Expand All @@ -278,6 +282,7 @@ winrt::hstring Microsoft::Windows::ApplicationModel::PackageDeploymentResolver::
TraceLoggingWideString(packageFamilyName.c_str(), "Criteria.PackageFamilyName"),
TraceLoggingHexUInt64(minVersion.Version, "Criteria.MinVersion"),
TraceLoggingHexInt32(static_cast<std::int32_t>(processorArchitectureFilter), "Criteria.ArchitectureFilter"),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
continue;
Expand All @@ -293,6 +298,7 @@ winrt::hstring Microsoft::Windows::ApplicationModel::PackageDeploymentResolver::
TraceLoggingWideString(packageFamilyName.c_str(), "Criteria.PackageFamilyName"),
TraceLoggingHexUInt64(minVersion.Version, "Criteria.MinVersion"),
TraceLoggingHexInt32(static_cast<std::int32_t>(processorArchitectureFilter), "Criteria.ArchitectureFilter"),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
return candidateFullName;
Expand All @@ -313,6 +319,7 @@ winrt::hstring Microsoft::Windows::ApplicationModel::PackageDeploymentResolver::
TraceLoggingWideString(packageFamilyName.c_str(), "Criteria.PackageFamilyName"),
TraceLoggingHexUInt64(minVersion.Version, "Criteria.MinVersion"),
TraceLoggingHexInt32(static_cast<std::int32_t>(processorArchitectureFilter), "Criteria.ArchitectureFilter"),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
}
Expand All @@ -325,6 +332,7 @@ winrt::hstring Microsoft::Windows::ApplicationModel::PackageDeploymentResolver::
TraceLoggingWideString(packageFamilyName.c_str(), "Criteria.PackageFamilyName"),
TraceLoggingHexUInt64(minVersion.Version, "Criteria.MinVersion"),
TraceLoggingHexInt32(static_cast<std::int32_t>(processorArchitectureFilter), "Criteria.ArchitectureFilter"),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
}
Expand Down
5 changes: 5 additions & 0 deletions dev/WindowsAppRuntime_BootstrapDLL/MddBootstrap.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -904,6 +904,7 @@ void FindDDLMViaEnumeration(
TraceLoggingHexUInt32(majorMinorVersion, "Criteria.MajorMinorVersion"),
TraceLoggingWideString(!versionTag ? L"" : versionTag, "Criteria.VersionTag"),
TraceLoggingHexUInt64(minVersion.Version, "Criteria.MinVersion"),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
int packagesScanned{};
Expand Down Expand Up @@ -999,6 +1000,7 @@ void FindDDLMViaEnumeration(
TraceLoggingHexUInt32(majorMinorVersion, "Criteria.MajorMinorVersion"),
TraceLoggingWideString(!versionTag ? L"" : versionTag, "Criteria.VersionTag"),
TraceLoggingHexUInt64(minVersion.Version, "Criteria.MinVersion"),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
continue;
Expand All @@ -1017,6 +1019,7 @@ void FindDDLMViaEnumeration(
TraceLoggingWideString(!versionTag ? L"" : versionTag, "Criteria.VersionTag"),
TraceLoggingHexUInt64(minVersion.Version, "Criteria.MinVersion"),
TraceLoggingWideString(::AppModel::Identity::GetCurrentArchitectureAsString(), "CurrentArchitecture"),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
continue;
Expand All @@ -1032,6 +1035,7 @@ void FindDDLMViaEnumeration(
TraceLoggingHexUInt32(majorMinorVersion, "Criteria.MajorMinorVersion"),
TraceLoggingWideString(!versionTag ? L"" : versionTag, "Criteria.VersionTag"),
TraceLoggingHexUInt64(minVersion.Version, "Criteria.MinVersion"),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
bestFitVersion = version;
Expand All @@ -1055,6 +1059,7 @@ void FindDDLMViaEnumeration(
TraceLoggingWideString(!versionTag ? L"" : versionTag, "Criteria.VersionTag"),
TraceLoggingHexUInt64(minVersion.Version, "Criteria.MinVersion"),
TraceLoggingInt32(packagesScanned, "PackagesScanned"),
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingLevel(WINEVENT_LEVEL_VERBOSE),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
ddlmPackageFamilyName = bestFitPackageFamilyName.c_str();
Expand Down
55 changes: 40 additions & 15 deletions dev/WindowsAppRuntime_BootstrapDLL/MddBootstrapTracelogging.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,27 @@

#include "pch.h"

#if __has_include("WindowsAppSDK-VersionInfo.h")
#include "WindowsAppSDK-VersionInfo.h"
#endif

#if defined(__WINDOWSAPPSDK_VERSIONINFO_H__)
#define TOSTRING_HELPER(x) #x
#define TOSTRING(x) TOSTRING_HELPER(x)
#define WINDOWSAPPSDK_RELEASE_VERSION TOSTRING(WINDOWSAPPSDK_RELEASE_MAJOR.WINDOWSAPPSDK_RELEASE_MINOR.WINDOWSAPPSDK_RELEASE_PATCH)
#else
#define WINDOWSAPPSDK_RELEASE_VERSION "0.0.0"
#define WINDOWSAPPSDK_RELEASE_CHANNEL "dev"
#define WINDOWSAPPSDK_RELEASE_CHANNEL_W L"dev"
#endif
_GENERIC_PARTB_FIELDS_ENABLED
#define _GENERIC_PARTB_FIELDS_ENABLED \
TraceLoggingStruct(4, "COMMON_WINDOWSAPPSDK_PARAMS"), \
TraceLoggingString(WINDOWSAPPSDK_RELEASE_VERSION, "Version"), \
TraceLoggingString(WINDOWSAPPSDK_RELEASE_CHANNEL, "WindowsAppSDKChannel"), \
TraceLoggingBool(wil::details::IsDebuggerPresent(), "IsDebugging"), \
TraceLoggingBool(true, "UTCReplace_AppSessionGuid")

bool __stdcall wilResultLoggingThreadCallback(const wil::FailureInfo& failure) noexcept;

GUID& GetLifetimeActivityId() noexcept;
Expand Down Expand Up @@ -35,7 +56,8 @@ class WindowsAppRuntimeBootstrap_TraceLogger final : public wil::TraceLoggingPro
TraceLoggingValue(!versionTag ? L"": versionTag, "versionTag"),
TraceLoggingValue(minVersion.Version, "minVersion"),
TraceLoggingValue(mddInitializeOptions, "mddInitializeOptions"),
TraceLoggingValue(initializationCount, "initializationCount"));
TraceLoggingValue(initializationCount, "initializationCount"),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
}
void StopWithResult(
const HRESULT hresult,
Expand All @@ -61,15 +83,17 @@ class WindowsAppRuntimeBootstrap_TraceLogger final : public wil::TraceLoggingPro
TraceLoggingValue(failureFile, "failureFile"),
TraceLoggingValue(failureLineNumber, "failureLineNumber"),
TraceLoggingValue(failureMessage, "failureMessage"),
TraceLoggingValue(failureModule, "failureModule"));
TraceLoggingValue(failureModule, "failureModule"),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
}
else
{
TraceLoggingClassWriteStop(Initialize,
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingValue(initializationCount, "initializationCount"),
TraceLoggingValue(IntegrityFlags, "IntegrityFlags"),
TraceLoggingValue(resolvedFrameworkPackageFullName, "resolvedFrameworkPackageFullName"));
TraceLoggingValue(resolvedFrameworkPackageFullName, "resolvedFrameworkPackageFullName"),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
}
}
END_ACTIVITY_CLASS();
Expand All @@ -86,7 +110,8 @@ class WindowsAppRuntimeBootstrap_TraceLogger final : public wil::TraceLoggingPro
TraceLoggingClassWriteStart(Shutdown,
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingValue(initializationCount, "initializationCount"),
TraceLoggingValue(resolvedFrameworkPackageFullName, "resolvedFrameworkPackageFullName"));
TraceLoggingValue(resolvedFrameworkPackageFullName, "resolvedFrameworkPackageFullName"),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
}
void StopWithResult(
HRESULT hresult,
Expand All @@ -108,13 +133,15 @@ class WindowsAppRuntimeBootstrap_TraceLogger final : public wil::TraceLoggingPro
TraceLoggingValue(failureFile, "FailureFile"),
TraceLoggingValue(failureLineNumber, "FailureLineNumber"),
TraceLoggingValue(failureMessage, "FailureMessage"),
TraceLoggingValue(failureModule, "FailureModule"));
TraceLoggingValue(failureModule, "FailureModule"),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
}
else
{
TraceLoggingClassWriteStop(Shutdown,
_GENERIC_PARTB_FIELDS_ENABLED,
TraceLoggingValue(initializationCount, "initializationCount"));
TraceLoggingValue(initializationCount, "initializationCount"),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance));
}
}
END_ACTIVITY_CLASS();
Expand All @@ -130,13 +157,11 @@ class WindowsAppRuntimeBootstrap_TraceLogger final : public wil::TraceLoggingPro
_eventname_,\
_activityId_,\
nullptr,\
_WRITE_FAILURE_INFO,\
TraceLoggingValue(static_cast<uint32_t>(failure.type), "Type"),\
TraceLoggingValue(failure.hr, "HResult"),\
TraceLoggingValue(failure.pszFile, "File"),\
TraceLoggingValue(failure.uLineNumber,"Line"),\
TraceLoggingValue(failure.pszModule, "Module"),\
TraceLoggingValue(failure.pszMessage,"Message"),\
_GENERIC_PARTB_FIELDS_ENABLED,\
__VA_ARGS__)

#define _WRITE_FAILURE_INFO \
TraceLoggingValue(static_cast<uint32_t>(failure.type), "Type"),\
TraceLoggingValue(failure.hr, "HResult"),\
TraceLoggingValue(failure.pszFile, "File"),\
TraceLoggingValue(failure.uLineNumber,"Line"),\
TraceLoggingValue(failure.pszModule, "Module"),\
TraceLoggingValue(failure.pszMessage,"Message")
Loading