Skip to content

Improve Get-WinEvent -ListLog exception handling #27395

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
daxian-dbw merged 2 commits into from
May 5, 2026
+36 −12
Merged

Improve Get-WinEvent -ListLog exception handling #27395

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f928750
Improve Get-WinEvent -ListLog exception handling
MartinGC94 May 4, 2026
07505c9
Apply suggestions from code review
MartinGC94 May 4, 2026
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
42 changes: 30 additions & 12 deletions src/Microsoft.PowerShell.Commands.Diagnostics/GetEventCommand.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -518,9 +518,11 @@ private void ProcessListLog()
||
(wildLogPattern.IsMatch(logName)))
{
EventLogConfiguration logObj;
EventLogInformation logInfoObj;
try
{
EventLogConfiguration logObj = new(logName, eventLogSession);
logObj = new EventLogConfiguration(logName, eventLogSession);

//
// Skip direct channels matching the wildcard unless -Force is present.
Expand All @@ -533,19 +535,25 @@ private void ProcessListLog()
continue;
}

EventLogInformation logInfoObj = eventLogSession.GetLogInformation(logName, PathType.LogName);

PSObject outputObj = new(logObj);
bMatchFound = true;
logInfoObj = eventLogSession.GetLogInformation(logName, PathType.LogName);
}
catch (UnauthorizedAccessException exc)
{

@MartinGC94 MartinGC94 May 4, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Certain log types are skipped so this cannot be moved to an earlier point.

string exceptionMsg = string.Format(CultureInfo.InvariantCulture, GetEventResources.LogInfoNoAccess, logName);
var newExc = new UnauthorizedAccessException(exceptionMsg, exc);

outputObj.Properties.Add(new PSNoteProperty("FileSize", logInfoObj.FileSize));
outputObj.Properties.Add(new PSNoteProperty("IsLogFull", logInfoObj.IsLogFull));
outputObj.Properties.Add(new PSNoteProperty("LastAccessTime", logInfoObj.LastAccessTime));
outputObj.Properties.Add(new PSNoteProperty("LastWriteTime", logInfoObj.LastWriteTime));
outputObj.Properties.Add(new PSNoteProperty("OldestRecordNumber", logInfoObj.OldestRecordNumber));
outputObj.Properties.Add(new PSNoteProperty("RecordCount", logInfoObj.RecordCount));
string recommendationMsg = GetEventResources.SuggestElevation;
var eRecord = new ErrorRecord(newExc, "LogInfoNoAccess", ErrorCategory.PermissionDenied, logName)
{
ErrorDetails = new ErrorDetails(string.Empty)
{
RecommendedAction = recommendationMsg
}
};

WriteObject(outputObj);
bMatchFound = true;
WriteError(eRecord);
continue;
}
catch (Exception exc)
{
Expand All @@ -556,6 +564,16 @@ private void ProcessListLog()
WriteError(new ErrorRecord(outerExc, "LogInfoUnavailable", ErrorCategory.NotSpecified, null));
continue;
}

PSObject outputObj = new(logObj);
outputObj.Properties.Add(new PSNoteProperty("FileSize", logInfoObj.FileSize));
outputObj.Properties.Add(new PSNoteProperty("IsLogFull", logInfoObj.IsLogFull));
outputObj.Properties.Add(new PSNoteProperty("LastAccessTime", logInfoObj.LastAccessTime));
outputObj.Properties.Add(new PSNoteProperty("LastWriteTime", logInfoObj.LastWriteTime));
outputObj.Properties.Add(new PSNoteProperty("OldestRecordNumber", logInfoObj.OldestRecordNumber));
outputObj.Properties.Add(new PSNoteProperty("RecordCount", logInfoObj.RecordCount));

WriteObject(outputObj);
Comment on lines +574 to +576
}
}

Expand Down
6 changes: 6 additions & 0 deletions src/Microsoft.PowerShell.Commands.Diagnostics/resources/GetEventResources.resx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,12 @@ The defined template is following:
<data name="LogInfoUnavailable" xml:space="preserve">
<value>To access the '{0}' log start PowerShell with elevated user rights. Error: {1}</value>
</data>
<data name="LogInfoNoAccess" xml:space="preserve">
<value>Access denied for log: '{0}'.</value>
</data>
<data name="SuggestElevation" xml:space="preserve">
<value>Launch PowerShell with elevated user rights.</value>
Comment on lines +258 to +262

@MartinGC94 MartinGC94 May 4, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But what is the text file used for?

</data>
<data name="NoEventMessage" xml:space="preserve">
<value>Cannot retrieve event message text.</value>
</data>
Expand Down
Loading