Messaging system - activity and ability to really stop it

[wsmelton]

[Update] - As of v2.0 release you can now disable the messaging and maintenance runspaces prior to importing the module.

Set the following environment variables in your system or session:

$env:DBATOOLS_DISABLE_TEPP = $true
$env:DBATOOLS_DISABLE_LOGGING = $true

Doing this before import will ensure the runspaces noted below do not start up, and additional connections for TEPP are not made to your systems during your session.

We don't seem to offer any viable way of turning off the message system, so it won't be so chatty on a given system.

If you Import-Module dbatools, by default, we spin up 3 runspaces right off:

You get rid of these using:

Get-Runspace -Name dbatools* | % {$_.Dispose()}

[Update]: Which we seem to do if we detect PowerShell ISE is in use:

dbatools/dbatools.psm1

Lines 1010 to 1018 in b8fe960

	# Removal of runspaces is needed to successfully close PowerShell ISE
	if (Test-Path -Path Variable:global:psISE) {
	$onRemoveScript = {
	Get-Runspace | Where-Object Name -like dbatools* | ForEach-Object -Process { $_.Dispose() }
	}
	$ExecutionContext.SessionState.Module.OnRemove += $onRemoveScript
	Register-EngineEvent -SourceIdentifier ([System.Management.Automation.PsEngineEvent]::Exiting) -Action $onRemoveScript
	}
	Write-ImportTime -Text "Checking for some ISE stuff"

At some point in the past parameter option was added to our PSM1 file where you can pass in an argument to Import-Module where serial import was occurr. So you can do this to get that same affect that having $dbatools_serialimport = $true set before you did the import:

Import-Module c:\git\dbatools\dbatools.psd1 -ArgumentList @{SerialImport = $true}

The logging runspace is where I believe all of our message system lives. The messaging system we have is loosely based on PSFrameworks (or the beginning birth of that module) but is no longer exact implementation of that module; customized for dbatools. The sections below layout the configuration options both with messages (color, output options, mode) that you can configure and the logging (this is where the runspace comes into play).

The current process that I'm seeing is the runspace spins up and then a log is created in the path set under the config path.dbatoolslogpath. Since those are spun up after import even if a user sets the configuration to disable it, those runspaces still continue to run unless you explicitly kill them.

I would love to have a parameter option added to the PSM1 that would allow passing in a key/value pair to say if XYZ is passed in pre-set the configuration category of ABC values to disabled/false/whatever.

Messaging Configuration

FullName                         Value  Description
--------                         -----  -----------
message.consoleoutput.disable    False  Global toggle that allows disabling all regular messages to screen. Messages from '-Verbose' and '-Debug' are unaffected
message.developercolor           Grey   The color to use when writing text with developer specific additional information to the screen on PowerShell.
message.info.color.emphasis      green  The color to use when emphasizing written text to the screen on PowerShell.
message.info.color.subtle        gray   The color to use when making writing text to the screen on PowerShell appear subtle.
message.infocolor                Cyan   The color to use when writing text to the screen on PowerShell.
message.maximumdebug             9      The maximum message level where debug information is still written.
message.maximuminfo              3      The maximum message level to still display to the user directly.
message.maximumverbose           6      The maxium message level where verbose information is still written.
message.minimumdebug             1      The minimum required message level where debug information is written.
message.minimuminfo              1      The minimum required message level for messages that will be shown to the user.
message.minimumverbose           4      The minimum required message level where verbose information is written.
message.mode.default             Strict The mode controls how some functions handle non-critical terminations by default. Strict: Write a warning | Lazy: Write
                                        a message | Report: Generate a report object
message.mode.lazymessagelevel    4      At what level will the lazy message be written? (By default invisible to the user)
message.nestedlevel.decrement    0      How many levels should be reduced per callstack depth. This makes commands less verbose, the more nested they are called
message.style.breadcrumbs        False  Controls how messages are displayed. Enables Breadcrumb display, showing the entire callstack. Takes precedence over
                                        command name display.
message.style.functionname       True   Controls how messages are displayed. Enables command name, showing the name of the writing command. Is overwritten by
                                        enabling breadcrumbs.
message.style.timestamp          True   Controls how messages are displayed. Enables timestamp display, including a timestamp in each message.
message.transform.errorqueuesize 512    The size of the queue for transformation errors. May be useful for advanced development, but can be ignored usually.

Logging Configuration

FullName                      Value      Description
--------                      -----      -----------
logging.errorlogenabled       False      Governs, whether a log of recent errors is kept in memory. This setting is on a per-Process basis. Runspaces share,
                                         jobs or other consoles counted separately.
logging.errorlogfileenabled   False      Governs, whether log files for errors are written. This setting is on a per-Process basis. Runspaces share, jobs or
                                         other consoles counted separately.
logging.maxerrorcount         128        The maximum number of error records maintained in-memory. This setting is on a per-Process basis. Runspaces share, jobs
                                         or other consoles counted separately.
logging.maxerrorfilebytes     20971520   The maximum size all error files combined may have. When this number is exceeded, the oldest entry is culled. This
                                         setting is on a per-Process basis. Runspaces share, jobs or other consoles counted separately.
logging.maxlogfileage         7.00:00:00 Any logfile older than this will automatically be cleansed. This setting is global.
logging.maxmessagecount       1024       The maximum number of messages that can be maintained in the in-memory message queue. This setting is on a per-Process
                                         basis. Runspaces share, jobs or other consoles counted separately.
logging.maxmessagefilebytes   5242880    The maximum size of a given logfile. When reaching this limit, the file will be abandoned and a new log created. Set to
                                         0 to not limit the size. This setting is on a per-Process basis. Runspaces share, jobs or other consoles counted
                                         separately.
logging.maxmessagefilecount   5          The maximum number of logfiles maintained at a time. Exceeding this number will cause the oldest to be culled. Set to 0
                                         to disable the limit. This setting is on a per-Process basis. Runspaces share, jobs or other consoles counted
                                         separately.
logging.maxtotalfoldersize    104857600  This is the upper limit of length all items in the log folder may have combined across all processes.
logging.messagelogenabled     False      Governs, whether a log of recent messages is kept in memory. This setting is on a per-Process basis. Runspaces share,
                                         jobs or other consoles counted separately.
logging.messagelogfileenabled False      Governs, whether a log file for the system messages is written. This setting is on a per-Process basis. Runspaces
                                         share, jobs or other consoles counted separately.

Path Configuration

❯ Get-DbatoolsConfig -Module path | fl FullName, Description, Value

FullName    : path.dbatoolsdata
Description : The path where dbatools stores persistent data on a per user basis.
Value       : C:\Users\smelton\AppData\Roaming\PowerShell\dbatools

FullName    : path.dbatoolsexport
Description : The default path where dbatools writes scripts generated by Export-* functions.
Value       : C:\Users\smelton\OneDrive\Documents\DbatoolsExport

FullName    : path.dbatoolslogpath
Description : The path where dbatools writes all its logs and debugging information.
Value       : C:\Users\smelton\AppData\Roaming\PowerShell\dbatools

FullName    : path.dbatoolstemp
Description : The path where dbatools stores temporary data.
Value       : C:\Users\smelton\AppData\Local\Temp

FullName    : path.managed.appdata
Description : Path pointing at the AppData path. Used with Get-DbatoolsPath.
Value       : C:\Users\smelton\AppData\Roaming

FullName    : path.managed.localappdata
Description : Path pointing at the LocalAppData path. Used with Get-DbatoolsPath.
Value       : C:\Users\smelton\AppData\Local

FullName    : path.managed.programdata
Description : Path pointing at the ProgramData path. Used with Get-DbatoolsPath.
Value       : C:\ProgramData

FullName    : path.managed.temp
Description : Path pointing at the temp path. Used with Get-DbatoolsPath.
Value       : C:\Users\smelton\AppData\Local\Temp

FullName    : path.servers
Description : The file in which dbatools stores the current user's server list, as managed by Get/Add/Update-DbaInstanceList
Value       : C:\Users\smelton\AppData\Roaming\PowerShell\dbatools\servers.xml

FullName    : path.tagcache
Description : The file in which dbatools stores the tag cache. That cache is used in Find-DbaCommand for more comfortable autocomplete
Value       : C:\Users\smelton\OneDrive\Documents\PowerShell\Modules\dbatools\1.1.143\bin\dbatools-index.json