如何构建PowerShell日志功能

密切关注脚本正在执行的操作对于监视和调试至关重要。如果您正在编写 PowerShell 脚本，则需要一个可在所有脚本中使用的首选 PowerShell 日志函数。

如果以交互方式调用脚本，即使用 Write-Verbose、Write-Information 或 Write-Host 等技术直接从控制台调用，则它很有用，因为每个命令都可以在脚本运行时在控制台上显示消息。

但是，如果这个脚本被计划任务或其他一些在运行时不涉及人类盯着屏幕的进程调用，该怎么办？在这种情况下，我们需要采用另一个级别的监控。监视不以交互方式运行的脚本的一个很好的方法是写入日志文件。

定义您需要记录的内容

在 PowerShell 中将文本写入文本文件有几种不同的方法，所使用的方法完全取决于开发人员。但是，在开始创建自己的 PowerShell 日志函数之前，需要记住一些事项。

• 所有日志行都必须是结构化内容。没有散落的松散的短信。
• 应记录每个日志条目的时间。
• 建议使用严重性或其他“标签”，以便稍后快速过滤日志文件中的信息。

相关：Set-Content：PowerShell 写入文件的方式

构建PowerShell日志函数支架

让我们看看如何构建 PowerShell 函数以合并到我们的任何脚本中。由于此函数需要可用于多个不同的脚本，因此我们将创建一个 PS1 脚本来存储我们的函数。该函数的名称将为Write-Log。

function Write-Log {
     [CmdletBinding()]
     param()
 
 }

此 PowerShell 日志函数每次调用时都会写入一条日志行。日志中的每一行都有两个属性，这些属性会根据我想要记录的内容而改变；消息和严重性，因此我将它们作为参数添加到我们的函数中。

function Write-Log {
    [CmdletBinding()]
    param(
        [Parameter()]
        [ValidateNotNullOrEmpty()]
        [string]$Message,
 
        [Parameter()]
        [ValidateNotNullOrEmpty()]
        [ValidateSet('Information','Warning','Error')]
        [string]$Severity = 'Information'
    )
 
 }

请注意，我选择将 Severity 参数的值限制为三个选项。通过限制选项，它确保我可以依赖此字段始终成为三种不同严重性之一。构建完参数后，我将使用 CSV 创建结构化日志文件。这将确保我可以在电子表格程序中快速提取日志文件并在必要时查看数据。

将输出添加到 PowerShell 日志函数

请注意，下面我还向 PowerShell 日志函数添加了时间。这不是参数，因为这始终是函数执行的时间。

function Write-Log {
    [CmdletBinding()]
    param(
        [Parameter()]
        [ValidateNotNullOrEmpty()]
        [string]$Message,
 
        [Parameter()]
        [ValidateNotNullOrEmpty()]
        [ValidateSet('Information','Warning','Error')]
        [string]$Severity = 'Information'
    )
 
    [pscustomobject]@{
        Time = (Get-Date -f g)
        Message = $Message
        Severity = $Severity
    } | Export-Csv -Path "$env:Temp\LogFile.csv" -Append -NoTypeInformation
 }

这就是我们的 Write-Log 函数的全部内容。现在，我们可以将其添加到我们喜欢的任何脚本中，只要我们首先对其进行点源即可。如果 Write-Log.ps1 脚本与我们调用它的脚本位于同一文件夹中；我们可以像 $PSScriptRoot\Write-Log.ps1 那样对它进行点源。

一旦脚本了解了该函数，就可以在脚本中根据需要多次调用该函数。

$foo = $false
if ($foo) {
    Write-Log -Message 'Foo was $true' -Severity Information
} else {
    Write-Log -Message 'Foo was $false' -Severity Error
}

然后，该信息将被记录到日志文件中，如下所示：

$foo = $false
if ($foo) {
    Write-Log -Message 'Foo was $true' -Severity Information
} else {
    Write-Log -Message 'Foo was $false' -Severity Error
}