Use PSFramework for logging

[SQLDBAWithABeard]

Using Write-Message for output will cause issues where users also have a Write-Message command in their session.

It also restricts the ability to provide granular functionality for outputting messages

It also restricts the type of logging available.

I suggest following dbatools and dbachecks example and using PSFramework for logging, this will enable exactly the same current functionality for output to the user, whilst adding further opportunities for logging (SQL Database, Azure blob storage, KQL, Log Analytics for example) which will be highly beneficial in automated processes

[NowinskiK]

Are we able to adopt this without changing all existing functions?
Before we start development on this, could you provide some snapshots of what the changes will look like?
I think this change might be good idea, but I haven't yet had time to do research about this.
Call out @tiagobalabuch for his opinion here as well.

Level - current	PSFramework - mapped Level
Message	???
Info	Host
Error	Error
Warning	Warning
Critical	Critical
Verbose	Verbose
Debug	Debug

[SQLDBAWithABeard]

Right now it is better and easier to do this per PR for logging to avoid confusion so yes

It can directly replace any Write-* calls without impacting any functionality.

Indeed the use of some of the other functionality of such as StopPsFunction in PSFramework will increase the usefulness of the logging and control flow. There is also the configuration but that is a for a different discussion.

What would the change look like?

Write-Message -Message $Message" -Level <Level>

would become

Write-PSFMessage -Message $Message -Level <Level>

You can find more details about the messaging functionality here

[NowinskiK]

When I run the following script:

Write-PSFMessage -Message 'Info Message' -Level Info
Write-PSFMessage -Message 'Error Message' -Level Error
Write-PSFMessage -Message 'Warning Message' -Level Warning
Write-PSFMessage -Message 'Critical Message' -Level Critical
Write-PSFMessage -Message 'Verbose Message' -Level Verbose
Write-PSFMessage -Message 'Debug Message' -Level Debug

I got this:

Should Info be new Critical message when using PSFramework?
That was the reason I put the mapping table above - to ensure we can appropriately map existing message types to the new ones.

[SQLDBAWithABeard]

You can find details about the module in the extensive documentation. There are many more options for level.

https://psframework.org/documentation/documents/psframework/logging.html

You will be able to map too your needs from there.

[NowinskiK]

@tiagobalabuch @jpomfret are we ok to keep the wrapper function Write-Message and make changes in there (changing 1 file)
OR we aim to change 1586 places to replace Write-Message by Write-PSFMessage?
I would prefer the first: less changes needed, single file to change, and wrapper could be modified in the future when needed, as one central place.
Similar wrapper is use in dbatools if I noticed correctly.