PSLogging

PSLogging is a logging module for PowerShell that provides useful features for logging information during script execution. It facilitates logging to a file or to the console with different levels of severity, including debug, verbose, warning, and error.

Installation

PSLogging can be installed using PowerShellGet:

Install-Module -Name PSLogging

Usage

After installing PSLogging, you can import the module and start logging information.

Importing the module

Import-Module PSLogging

Logging to a file

Set-PSLogFile -Path "C:\Logs\MyScript.log" -Level Debug

Write-PSLogMessage -Message "Starting script execution..."

# ... script code ...

Write-PSLogMessage -Message "End of script execution."

The above example sets the log file path to "C:\Logs\MyScript.log" with a debug level, meaning all log messages with any level equal to or higher than debug will be written to the file. Additionally, two log messages are written, one at the start and one at the end of the script execution.

Logging to the console

Set-PSLogConsole -Level Warning

Write-PSLogMessage -Message "This is a debug log message." -Level Debug
Write-PSLogMessage -Message "This is a verbose log message." -Level Verbose
Write-PSLogMessage -Message "This is a warning log message." -Level Warning
Write-PSLogMessage -Message "This is an error log message." -Level Error

The above example sets the console log level to warning, meaning only log messages with levels warning and error will be written to the console. Four log messages are then written, with different levels. The debug and verbose log messages will not appear in the console since their levels are lower than the console log level.

Additional features

PSLogging provides more features than the ones shown in the previous examples, including:

• Logging to remote destinations such as Windows Event Log, Syslog, or Graylog.
• Customizing log message format with timestamps, source script information, or custom fields.
• Log message buffering and batch writing to optimize log file writing performance.

For more information, refer to the PSLogging documentation.