模块和点源脚本中的 Powershell 日志记录

Question

我有几个函数存储在一个 .psm1 文件中，供几个不同的 ps1 脚本使用。我创建了一个日志记录函数（如下所示），我在这些 ps1 脚本中都使用了它。通常，我通过简单地调用类似的东西在脚本中导入模块：

Import-Module $PSScriptRoot\Module_Name.psm1

然后在模块内，我有一个写记录器功能：

Write-Logger -Message "Insert log message here." @logParams

此函数在整个主脚本和模块本身中都使用。喷溅参数@logParams 在我的主 .ps1 文件中定义，并没有显式传递给模块，我想这些变量在导入时隐含在模块的范围内。我有什么作品，但我觉得这不是一个很好的做法。在我的模块中添加 param 块以要求从主 .ps1 脚本显式传递 @logParams 会更好吗？谢谢！

function Write-Logger() {
    [cmdletbinding()]
    Param (
        [Parameter(Mandatory=$true)]
        [string]$Path,
        [Parameter(Mandatory=$true)]
        [string]$Message,
        [Parameter(Mandatory=$false)]
        [string]$FileName = "Scheduled_IDX_Backup_Transcript",
        [switch]$Warning,
        [switch]$Error
    )
    # Creates new log directory if it does not exist
    if (-Not (Test-Path ($path))) {
        New-Item ($path) -type directory | Out-Null
    }

    if ($error) {
        $label = "Error"
    }
    elseif ($warning) {
        $label = "Warning"    
    }
    else {
        $label = "Normal"
    }

    # Mutex allows for writing to single log file from multiple runspaces
    $mutex = new-object System.Threading.Mutex $false,'MutexTest'
    [void]$mutex.WaitOne()
    Write-Host "$(Format-LogTimeStamp) $label`: $message"
    "$(Format-LogTimeStamp) $label`: $message" | Out-file "$path\$fileName.log" -encoding UTF8 -append
    [void]$mutex.ReleaseMutex()
}

Answer 1

我在 ps1 中有这段代码，我将源代码添加到要生成自己的日志的脚本中。 ps1 包含simpleLogger 类以及下面创建全局变量的例程。该脚本可以再次点源，并将全局变量值传递给随后生成的作业以维护单个日志文件。

class simpleLogger
{
    [string]$source
    [string]$target
    [string]$action
    [datetime]$datetime
    hidden [string]$logFile = $global:simpleLog

    simpleLogger()
    {
        $this.datetime = Get-Date
    }

    simpleLogger( [string]$source, [string]$target, [string]$action )
    {
        $this.action = $action
        $this.source = $source
        $this.target = $target
        $this.datetime = Get-Date
    }

    static [simpleLogger] log( [string]$source, [string]$target, [string]$action )
    {
        $newLogger = [simpleLogger]::new( [string]$source, [string]$target, [string]$action )
        do {
            $done = $true
            try {
                $newLogger | export-csv -Path $global:simpleLog -Append -NoTypeInformation
            }
            catch {
                $done = $false
                start-sleep -milliseconds $(get-random -min 1000 -max 10000)
            }
        } until ( $done )
        return $newLogger
    }
}

if( -not $LogSession ){

    $global:logUser = $env:USERNAME
    $global:logDir = $env:TEMP + "\"
    $startLog = (get-date).tostring("MMddyyyyHHmmss")
    $global:LogSessionGuid = (New-Guid)
    $global:simpleLog = $script:logDir+$script:logUser+"-"+$LogSessionGuid+".log"
    [simpleLogger]::new() | export-csv -Path $script:simpleLog -NoTypeInformation
    $global:LogSession = [simpleLogger]::log( $script:logUser, $LogSessionGuid, 'Log init' )

}