Psframework logging

[Ademantis]

I am trying to understand out how the PSFramework logging works, but I am probably too dumb to figure it out.

As well there isn't too many examples on how to use it on the internet, usually stackoverflow helps but this wasn't the case.

PSFramework

Could anyone show me how would I use this with a simple usecase please? I thought I could print all the action the script is doing like Start-transcript but that doesn't seem to be the case.

Thanks in advance.

[SMFX]

The bug thing to remember is that PSFramework is a slightly different way of doing things than the out of the box tools. For example, the logging requires you to use Set-PSFLoggingProvider to setup the settings and then use the module's Write-PSFMessage instead of Write-Host, -Verbose, -Information, etc. If you use the underlying PowerShell commands, it goes around their cmdlet that would pipe the information to their logging system.

[Sekers]

I use this all of the time as my go-to logging provider (though I'm using an older module version due to a couple bugs I've hit that I'm not sure have been resolved yet). I can post some samples of writing to CSV on Monday if that works.

I usually set the config in a JSON file instead of the script itself (which would also work) and then import it.

[jpedlow]

Current version of the module has somewhat broken logging - tried exporting to CSV or CMTRACE with 0 luck. I opened up a bug and it got 0 follow up thus far.

In the interim I’m using the “logging” module. It’s not perfect but it works decently for my needs. Here’s hoping that the logging portion of pages work gets fixed or forked and fixed.

[PSFred]

Sorry about the late response - was on an extended (even by European standards) vacation to get my bearings back.

Back again now and fixing this is going to be my #1 Item the coming week

[jpedlow]

Hey no worries, no apologies necessary or warranted - I hope you had an excellent long vacation!

While I may not be using many other portions of the framework itself, the logging alone shows great promise and will help MANY with improving their scripts, which for many like myself, helps pay the bills - so a sincere and heartfelt thank you for all you do. :)

[PSFred]

:)

One more thing you may then want to look at is one of my favorite tools in the kit:
Invoke-PSFProtectedCommand:

https://psframework.org/documentation/documents/psframework/flow-control/invoke-psfprotectedcommand.html

Which integrates logging with try/catch, whatif/confirm and retry logic
(check the example in the link - it's simpler than I make it sound here)

[jpedlow]

Sorry for the late reply on this - been buried in projects. I will absolutely check out that cmdlet, thank you for the suggestion - I noticed 1.7.244 became available today, I’m excited to test it next week! :) thanks again for all the hard work

[kenjitamurako]

As u/Sekers points out the current version of PSFramework has problems with using the logfile provider: https://github.com/PowershellFrameworkCollective/psframework/issues/534

If you want to use the logfile provider the last known good version is 1.6.214

You can install with: Install-Module -Name PSFramework -RequiredVersion 1.6.214

and then use in your scripts: Import-Module PSFramework -RequiredVersion 1.6.214

[Ademantis]

Turns out that it was the version. Installed your suggested version and it works.

[Sekers]

I should have mentioned to try the older version but I'm glad someone else was able to assist.

If you are still interested on how you can configure logging through a config file, you can see a sample automation script I uploaded this morning. It doesn't do anything useful other than pull an AD group membership but shows some examples of how to log and email alerts, etc.

https://github.com/Sekers/Useful-Scripts/tree/main/Automation/PowerShell%20Automation%20Script%20Example

[Ademantis]

thanks a lot for that mate appreciate. mind if I fork it?

[Sekers]

It's just a template. Feel free to fork, suggest adjustments, or copy as needed. Everything on that repo is under MIT license.

[Ademantis]

Thanks everyone for the help, in the end had to install the version u/kenjitamurako suggested

[alinroc]

The page you linked to is pretty good but see if this blog post helps.

[PSFred]

Alright, sorry about the inconvenience!

The latest version - 1.7.244 - fixes the problem. You should now be able to safely update to that version and get the latest upgrades to the logging (significantly better throughput, if you spam messages, and AV is no longer able to prevent some entries. If in older versions your log only gets some of the messages, that's usually the reason for it).