Error logging patterns in PowerShell - Step-by-Step Execution

Concept Flow - Error logging patterns

Start Script

↓

Try Block

↓

Execute Command

↓

Error?

Yes→Catch Block

↓

Log Error

↓

Optional: Notify

↓

Continue or Exit

The script tries to run commands, catches errors if they happen, logs them, and optionally notifies before continuing or exiting.

Execution Sample

PowerShell

try {
  Get-Item 'C:\nonexistentfile.txt'
} catch {
  Write-Error "Error: $_"
  Add-Content -Path 'error.log' -Value "$(Get-Date): $_"
}

This script tries to get a file, logs an error message if it fails, and writes the error details to a log file.

Execution Table

Step	Action	Command/Expression	Result	Output/Log
1	Start try block	Get-Item 'C:\nonexistentfile.txt'	File not found error thrown
2	Catch error	$_	Contains error details
3	Write error to console	Write-Error "Error: $_"	Error message displayed	Error: Cannot find path 'C:\nonexistentfile.txt' because it does not exist.
4	Log error to file	Add-Content -Path 'error.log' -Value "$(Get-Date): $_"	Error appended to error.log	Log file updated with timestamp and error
5	End script		Script ends after logging

💡 Error caught and logged, script ends gracefully without crashing

Variable Tracker

Variable	Start	After Step 1	After Step 2	After Step 4	Final
$_	null	null	ErrorRecord object with file not found message	Same ErrorRecord object	Same ErrorRecord object

Key Moments - 3 Insights

Why does the script not crash when the file is missing?

Because the error is caught in the catch block (see execution_table step 2), preventing the script from stopping unexpectedly.

What does the variable $_ represent in the catch block?

It holds the error details caught by the catch block (see variable_tracker after step 2), which we use to log and display the error.

How does the script log the error to a file?

Using Add-Content to append a timestamped error message to 'error.log' (see execution_table step 4), so errors are recorded for later review.

Visual Quiz - 3 Questions

Look at the execution table, what is the output at step 3?

A File content printed

B Error message displayed on console

C No output

D Script crashes

💡 Hint

Check the 'Output/Log' column at step 3 in the execution_table

At which step does the script write the error to the log file?

A Step 2

B Step 3

C Step 4

D Step 5

💡 Hint

Look for 'Log error to file' action in the execution_table

If the file exists, what happens to the catch block?

A It is skipped, no error occurs

B It runs and logs an error

C It runs but logs no error

D Script crashes

💡 Hint

Catch block only runs if an error occurs, see concept_flow and execution_table step 1

Concept Snapshot

PowerShell error logging pattern:
try { <command> } catch { <handle error> }
Use $_ in catch to access error details.
Log errors with Add-Content to a file.
Prevents script crashes by handling errors gracefully.

Full Transcript

This PowerShell script tries to get a file. If the file does not exist, an error occurs. The catch block catches this error and stores it in $_. The script then writes an error message to the console and appends the error details with a timestamp to a log file named error.log. This pattern helps keep scripts running smoothly by handling errors and recording them for later review.