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.

Practice

1. What is the main purpose of using try/catch blocks in PowerShell scripts for error logging?

easy

A. To automatically fix errors

B. To speed up script execution

C. To catch errors and handle them gracefully

D. To ignore all errors silently

Solution

1. Step 1: Understand the role of try/catch

   The try block runs code that might cause errors, and the catch block handles those errors.

2. Step 2: Purpose of error handling

   Using try/catch helps scripts manage errors without stopping abruptly, allowing logging or recovery.

3. Final Answer:

   To catch errors and handle them gracefully -> Option C

4. Quick Check:

   Error handling = catch errors [OK]

Hint: Try/catch blocks catch and handle errors safely [OK]

Common Mistakes:

• Thinking try/catch fixes errors automatically
• Believing try/catch speeds up scripts
• Assuming try/catch ignores errors

2. Which of the following is the correct syntax to write an error message with a timestamp to a log file in PowerShell?

easy

A. Add-Content error.log "$(Get-Date): Error occurred"

B. Write-Error "$(Get-Date): Error occurred" >> error.log

C. Write-Output "Error occurred at $(Get-Date)" > error.log

D. Write-Host "$(Get-Date): Error occurred" >> error.log

Solution

1. Step 1: Identify correct cmdlet for appending text

   Add-Content appends text to a file without overwriting it, suitable for logging.

2. Step 2: Check timestamp and message format

   Using "$(Get-Date): Error occurred" correctly adds a timestamp and message.

3. Final Answer:

   Add-Content error.log "$(Get-Date): Error occurred" -> Option A

4. Quick Check:

   Append log with Add-Content [OK]

Hint: Use Add-Content to append logs with timestamps [OK]

Common Mistakes:

• Using Write-Error which writes to error stream, not file
• Using Write-Host which outputs to console only
• Using > which overwrites the file instead of appending

3. What will be the output of this PowerShell snippet?

try {
  Get-Item 'C:\nonexistentfile.txt'
} catch {
  Add-Content error.log "$(Get-Date): File not found error"
  'Error logged'
}

medium

A. No output, only error.log updated

B. Error logged

C. File not found error

D. Script stops with error

Solution

1. Step 1: Analyze try block

   The command tries to get a file that does not exist, causing an error.

2. Step 2: Analyze catch block

   The catch block appends a timestamped error message to error.log and outputs the string 'Error logged'.

3. Final Answer:

   Error logged -> Option B

4. Quick Check:

   Catch outputs message after logging [OK]

Hint: Catch block outputs text after logging error [OK]

Common Mistakes:

• Thinking no output appears because only file is updated
• Expecting script to stop on error
• Confusing error message with output string

4. Identify the error in this PowerShell error logging snippet:

try {
  Get-Content 'C:\missing.txt'
} catch {
  Write-Error "$(Get-Date): File missing"
  Add-Content error.log "File missing"
}

medium

A. Catch block should not write to error stream

B. Write-Error should be replaced with Write-Host to log properly

C. Try block syntax is incorrect

D. Add-Content should include timestamp for better logs

Solution

1. Step 1: Review logging commands

   Write-Error writes to error stream, which is okay for alerting, but Add-Content logs to file without timestamp.

2. Step 2: Importance of timestamps in logs

   Logs without timestamps make tracking errors over time difficult; adding $(Get-Date) improves log usefulness.

3. Final Answer:

   Add-Content should include timestamp for better logs -> Option D

4. Quick Check:

   Logs need timestamps for clarity [OK]

Hint: Always add timestamps when logging errors to files [OK]

Common Mistakes:

• Thinking Write-Error cannot be used in catch
• Ignoring importance of timestamps in logs
• Assuming try block syntax is wrong

5. You want to create a PowerShell script that logs errors with timestamps and the error message to a file, but only if the error is not a 'FileNotFoundException'. Which pattern correctly implements this?

hard

A. try {
# code
} catch [System.IO.FileNotFoundException] {
# ignore
} catch {
Add-Content error.log "$(Get-Date): $_"
}

B. try {
# code
} catch {
if ($_ -notlike '*FileNotFoundException*') {
Add-Content error.log "$(Get-Date): $_"
}
}

C. try {
# code
} catch {
Add-Content error.log "$(Get-Date): $_"
}

D. try {
# code
} catch [System.Exception] {
Add-Content error.log "$(Get-Date): $_"
}

Solution

1. Step 1: Understand exception filtering

   Using a typed catch block for FileNotFoundException allows ignoring that specific error.

2. Step 2: Use a general catch for other errors

   The second catch block logs all other errors with timestamp and message.

3. Final Answer:

   Typed catch ignores FileNotFoundException; general catch logs others -> Option A

4. Quick Check:

   Typed catch filters errors correctly [OK]

Hint: Use typed catch to skip specific errors [OK]

Common Mistakes:

• Logging all errors without filtering
• Using if condition incorrectly inside catch
• Not using typed catch blocks