Skip to content

Add TraceLogging tagging and generic fields to failure events. #5283

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

Merged
agniuks merged 1 commit into from
Mar 28, 2025
Merged

Add TraceLogging tagging and generic fields to failure events. #5283

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 17 additions & 10 deletions installer/dev/tracelogging.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,11 @@ void __stdcall wilResultLoggingCallback(const wil::FailureInfo& failure) noexcep
}
else
{
WindowsAppRuntimeInstaller_WriteEventWithActivity("FailureLog");
WindowsAppRuntimeInstaller_WriteEventWithActivity(
"FailureLog",
_GENERIC_PARTB_FIELDS_ENABLED,
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingKeyword(MICROSOFT_KEYWORD_CRITICAL_DATA));
}
installActivityContext.LogInstallerFailureEvent(failure.hr);
break;
Expand All @@ -52,9 +56,10 @@ void __stdcall wilResultLoggingCallback(const wil::FailureInfo& failure) noexcep
{
WindowsAppRuntimeInstaller_WriteEventWithActivity(
"Exception",
TraceLoggingCountedWideString(
installActivityContext.GetCurrentResourceId().c_str(),
static_cast<ULONG>(installActivityContext.GetCurrentResourceId().size()), "currentResource"));
_GENERIC_PARTB_FIELDS_ENABLED,
WindowsAppRuntimeInstaller_TraceLoggingWString(installActivityContext.GetCurrentResourceId(), "currentResource"),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingKeyword(MICROSOFT_KEYWORD_CRITICAL_DATA));

// Don't stop the Install activity here. Instead, give the Installer main a chance to Stop the Activity before returning error to the caller.
// Hence, save the wil failure info here for later use.
Expand All @@ -65,9 +70,10 @@ void __stdcall wilResultLoggingCallback(const wil::FailureInfo& failure) noexcep
{
WindowsAppRuntimeInstaller_WriteEventWithActivity(
"FailFast",
TraceLoggingCountedWideString(
installActivityContext.GetCurrentResourceId().c_str(),
static_cast<ULONG>(installActivityContext.GetCurrentResourceId().size()), "currentResource"));
_GENERIC_PARTB_FIELDS_ENABLED,
WindowsAppRuntimeInstaller_TraceLoggingWString(installActivityContext.GetCurrentResourceId(), "currentResource"),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingKeyword(MICROSOFT_KEYWORD_CRITICAL_DATA));

installActivityContext.GetActivity().StopWithResult(
failure.hr,
Expand All @@ -89,9 +95,10 @@ void __stdcall wilResultLoggingCallback(const wil::FailureInfo& failure) noexcep
{
WindowsAppRuntimeInstaller_WriteEventWithActivity(
"FailureReturn",
TraceLoggingCountedWideString(
installActivityContext.GetCurrentResourceId().c_str(),
static_cast<ULONG>(installActivityContext.GetCurrentResourceId().size()), "currentResource"));
_GENERIC_PARTB_FIELDS_ENABLED,
WindowsAppRuntimeInstaller_TraceLoggingWString(installActivityContext.GetCurrentResourceId(), "currentResource"),
TelemetryPrivacyDataTag(PDT_ProductAndServicePerformance),
TraceLoggingKeyword(MICROSOFT_KEYWORD_CRITICAL_DATA));

// If this is due to CATCH_RETURN(), we want to keep the failure info from THROW* and not overwrite that from RETURN*
if (!(installActivityContext.GetLastFailure().type == wil::FailureType::Exception &&
Expand Down