Error logging patterns in PowerShell

Introduction

Error logging helps you find and fix problems by saving details about what went wrong.

When running scripts that might fail and you want to know why.

When automating tasks and need to keep a record of errors for later review.

When debugging a script that behaves unexpectedly.

When you want to alert someone or take action if an error happens.

When you want to keep your script running even if some parts fail.

Syntax

PowerShell

try {
  # Code that might cause an error
} catch {
  # Code to handle the error
  Write-Error "Error message"
  Add-Content -Path error.log -Value $_.Exception.Message
}

try runs code that might fail.

catch runs if an error happens, letting you log or handle it.

Examples

This tries to get a file. If it doesn't exist, it shows an error message.

PowerShell

try {
  Get-Item 'C:\nonexistentfile.txt'
} catch {
  Write-Error "File not found: $_"
}

This tries to divide by zero, catches the error, and writes it to a log file.

PowerShell

try {
  $result = 1 / 0
} catch {
  Add-Content -Path 'error.log' -Value "Divide by zero error: $_"
}

This tries to get a web page. On failure, it logs the error with a timestamp.

PowerShell

try {
  Invoke-WebRequest 'http://badurl'
} catch {
  Write-Error "Web request failed: $_"
  Add-Content -Path 'error.log' -Value "$(Get-Date): $_"
}

Sample Program

This script tries to read a file. If it fails, it logs the error with the date and time to a file and shows an error message.

PowerShell

try {
  # Attempt to read a file that may not exist
  $content = Get-Content 'C:\temp\data.txt'
  Write-Output "File content loaded successfully."
} catch {
  # Log error message with timestamp
  $errorMessage = "$(Get-Date -Format 'yyyy-MM-dd HH:mm:ss') - Error reading file: $($_.Exception.Message)"
  Add-Content -Path 'C:\temp\error.log' -Value $errorMessage
  Write-Error $errorMessage
}

Important Notes

Use try/catch to keep your script from stopping on errors.

Log errors with timestamps to track when problems happen.

Use Write-Error to show errors clearly in the console.

Summary

Error logging helps find and fix script problems.

Use try/catch blocks to catch and log errors.

Always add timestamps to error logs for better tracking.

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