PSNLog PowerShell module

The "PSNLog" PowerShell module is a wrapper around the famous, flexible and free open source logging for .Net component NLog.

Proper logging is a common requirement within most PowerShell scripts and modules. There are a lot of possibilities to support logging within PowerShell. However, most of them are very limited in their capabilities and/or intrusive to the script/module.

This Module allows to use all the capabilities and the flexibility of NLog with as little as two lines of PowerShell.

Requirements

PowerShell Version 3.0+

Third party components

1. NLog - Copyright (c) 2004-2018 Jaroslaw Kowalski [email protected], Kim Christensen, Julian Verdurmen. Please see License.

Install

PowerShell Gallery Install (Requires PowerShell v5)

    Install-Module -Name PSNLog

Manual Install

Download PSNLog-0.2.5.zip and extract the contents into 'C:\Users\[User]\Documents\WindowsPowerShell\Modules\PSNlog' (you may have to create these directories if they don't exist.). Then run

    Get-ChildItem 'C:\Users\[User]\Documents\WindowsPowerShell\Modules\PSNLog\' -Recurse | Unblock-File
    Import-Module PSNlog

Add logging to scripts/modules

Quickly add logging capabilities to existing scripts/modules with two lines of PowerShell code

The easiest and quickest way to make use of this requires two easy steps

1. Import the Module
2. Create a simple configuration for NLog and redirect native functions.

    Import-Module PSNlog
    Enable-NLogLogging

This will create a very simple standard configuration, that writes log messages to a log file with the same name as the script file within the %Temp% director. If it is not called from within a script, it will use the name 'PSNLog' as default. To allow easy integration for existing scripts and modules, it implements a little trick that basically write the content of every call to Write-Verbose, Write-Host, Write-Warning and Write-Error into the log file as well.

On default, messages written by Write-Verbose will have a log level of Debug, Write-Host a log level of Info, Write-Warning a log level of Warn and Write-Error a log level of Error. Please see the NLog Wiki for more details about the different log levels.

You can now test the behaviour by calling

    Write-Verbose 'This is a verbose message'
    Write-Host 'This is a "Host" message'
    Write-Warning 'This is a warning message'
    Write-Error 'This is an error message'

The Cmdlets will still write proper output as they are supposed to. If you now check the logfile, you should see the messages also being logged to the log file. On default, it's using the '${cmtrace}' layout renderer, to write log messages in a format that is consumable by CMTrace. A real-time log viewer used in Microsoft System Center Configuration Manager. As that's basically what I'm dealing with most of the time ;)

Quickly add logging to a specific logfile

In case you might want to write to a different location, you can also specify the exact filename or even use other Layout Renderer from Nlog. E.g. to write every log level to a different file, you could use the following

    Import-Module PSNlog
    Enable-NLogLogging -FileName '${env:temp}/${level}.log'

or you might want to use a different layout. E.g. the one used on default by NLog:

    Enable-NLogLogging -FileName '${env:scriptroot}/${level}.log' -Layout '${longdate}|${level:uppercase=true}|${logger}|${message}'

In case you don't want to have this automatic redirection of the Write-* CmdLets, just supply the parameter DontRedirectMessages.

Customize logging

While using Write-Verbose, Write-Host, Write-Warning and Write-Error is a good and easy start, you might want to have a bit more control about the log messages that are created within your script. Especially about the individual levels. e.g. you might want to make proper use of the Info level without using Write-Host (You shouldn't use Write-Host. Really, don't!).

So lets log to a custom log file and enable daily archiving of this log file

    $Target = New-NLogFileTarget -Name 'MyFileTArget' `
                                 -Filename 'C:\Temp\MyLogFile.log' `
                                 -ArchiveFileName 'C:\Temp\Archive\MyLog.{#}.log' `
                                 -ArchiveNumbering Date `
                                 -ArchiveEvery Day `
                                 -MaxArchiveFiles 14 `
                                 -ArchiveDateFormat 'yyyyMMdd' `
                                 -EnableArchiveFileCompression
    Enable-NLogLogging -Target $Target -DontRedirectMessages

Then write log messages as following

    $Logger = Get-NLogLogger

    $Logger.Debug("Some debug message")
    $Logger.Info("Some info message")
    $Logger.Warn("Some warn message")
    $Logger.Error("Some error message")
    $Logger.Trace("Some trace message")

Contributors

• Maik Koster

License

• see LICENSE file

Contact

• Twitter: @Maik_Koster
• Blog: MaikKoster.com