Error logging patterns in PowerShell - Mini Project: Build & Apply

Error Logging Patterns in PowerShell

📖 Scenario: You are managing a PowerShell script that runs several commands. You want to capture errors in a structured way to help troubleshoot issues later.

🎯 Goal: Build a PowerShell script that runs commands, logs errors into a dictionary with error messages and counts, and then displays the error summary.

📋 What You'll Learn

Create a dictionary to store error messages and their counts

Add a variable to hold the list of commands to run

Run each command and catch errors, updating the dictionary

Print the error summary with messages and counts

💡 Why This Matters

🌍 Real World

Scripts often run multiple commands where some may fail. Logging errors helps track and fix issues efficiently.

💼 Career

Error logging is a key skill for DevOps engineers to maintain reliable automation scripts and troubleshoot failures.

1

Create the error log dictionary

Create a dictionary called $ErrorLog initialized as an empty hashtable to store error messages and their counts.

PowerShell

# Your code here

Hint

Use @{} to create an empty hashtable in PowerShell.

2

Define commands to run

Create a variable called $Commands and assign it an array with these exact strings: 'Get-Process', 'Get-Service', and 'Get-NonExistentCommand'.

PowerShell

$ErrorLog = @{}
# Your code here

Hint

Use @( ... ) to create an array in PowerShell.

3

Run commands and log errors

Use a foreach loop with variable $cmd to iterate over $Commands. Inside the loop, run Invoke-Expression $cmd inside a try block. Catch errors in a catch block. In the catch block, get the error message from $_.Exception.Message. If the message is already a key in $ErrorLog, increment its value by 1; otherwise, add it with value 1.

PowerShell

$ErrorLog = @{}
$Commands = @('Get-Process', 'Get-Service', 'Get-NonExistentCommand')
# Your code here

Hint

Use try { ... } catch { ... } to handle errors in PowerShell.

Use Invoke-Expression to run the command string.

4

Print the error summary

Use a foreach loop with variables $message and $count to iterate over $ErrorLog.GetEnumerator(). Inside the loop, print the error message and count in the format: Error: {message} - Count: {count} using Write-Output.

PowerShell

$ErrorLog = @{}
$Commands = @('Get-Process', 'Get-Service', 'Get-NonExistentCommand')
foreach ($cmd in $Commands) {
    try {
        Invoke-Expression $cmd
    } catch {
        $msg = $_.Exception.Message
        if ($ErrorLog.ContainsKey($msg)) {
            $ErrorLog[$msg] += 1
        } else {
            $ErrorLog[$msg] = 1
        }
    }
}
# Your code here

Hint

Use $ErrorLog.GetEnumerator() to loop over hashtable keys and values.

Use Write-Output to print lines.

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