Skip to content
AnotherSadGit edited this page Sep 30, 2023 · 8 revisions

Introduction to Pslogg

Pslogg is a PowerShell module for logging messages to the host, to PowerShell streams, or to a log file.

Intended Use

Logging success or errors from PowerShell scripts executed manually. For example, when system administrators are running scripts to make changes to a system or deploy updates.

Pslogg has features designed to help administrators determine whether every step performed by a change script was successful or not:

  • Different logging levels displayed in different colors in the PowerShell console. For example, INFORMATION messages may be displayed in white while ERROR messages may be displayed in red.

  • User-defined Categories: Users may define categories that different log messages belong to. This facilitates filtering the log file and also allows different categories to be displayed in different colors in the PowerShell console. For example, messages with category "Success" might be displayed in green while messages with category "Failure" might be displayed in red.

While Pslogg is designed around scripts that will be run manually, it can also be used in modules or other automated scripts. To facilitate wiring Pslogg output into monitoring tools or SIEM tools, Pslogg provides the option of routing output to PowerShell streams.

Getting Started

See the Quick Start page for how to install Pslogg, and the basics of writing log messages with it.

Clone this wiki locally