< Back
Register-PSFLoggingProvider
Post
NAME Register-PSFLoggingProvider
SYNOPSIS
Registers a new logging provider to the PSFramework logging system.
SYNTAX
Register-PSFLoggingProvider [-Name] <String> [-Enabled] [[-RegistrationEvent] <ScriptBlock>] [[-BeginEvent]
<ScriptBlock>] [[-StartEvent] <ScriptBlock>] [-MessageEvent] <ScriptBlock> [[-ErrorEvent] <ScriptBlock>]
[[-EndEvent] <ScriptBlock>] [[-FinalEvent] <ScriptBlock>] [[-ConfigurationParameters] <ScriptBlock>]
[[-ConfigurationScript] <ScriptBlock>] [[-IsInstalledScript] <ScriptBlock>] [[-InstallationScript] <ScriptBlock>]
[[-InstallationParameters] <ScriptBlock>] [[-ConfigurationSettings] <ScriptBlock>] [-EnableException]
[<CommonParameters>]
DESCRIPTION
This function registers all components of the PSFramework logging provider systems.
It allows you to define your own logging destination and configuration and tie them into the default logging
system.
In order to properly utilize its power, it becomes necessary to understand how the logging works beneath the
covers:
- On Start of the logging script, it runs a one-time scriptblock per enabled provider (this will also occur when
later enabling a provider)
- Thereafter the script will continue, logging in cycles of Start > Log all Messages > Log all Errors > End
Each of those steps has its own event, allowing for fine control over what happens where.
- Finally, on shutdown of a provider it again offers an option to execute some code (to dispose/free resources in
use)
All providers share the same scope for the execution of ALL of those actions/scriptblocks!
This makes it important to give your variables/functions a unique name, in order to avoid conflicts.
General Guideline:
- All variables should start with the name of the provider and an underscore. Example: $filesystem_root
- All functions should use the name of the provider as prefix. Example: Clean-FileSystemErrorXml
A simple implementation example can be seen with the FileSystem provider, stored in the module folder:
internal/loggingProvider/filesystem.provider.ps1
PARAMETERS
-Name <String>
A unique name for your provider. Registering a provider under a name already registered, NOTHING will happen.
This function will instead silently terminate.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Enabled [<SwitchParameter>]
Setting this will enable the provider on registration.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RegistrationEvent <ScriptBlock>
Scriptblock that should be executed on registration.
This allows you to perform installation actions synchronously, with direct user interaction.
At the same time, by adding it as this parameter, it will only performed on the initial registration, rather
than every time the provider is registered (runspaces, Remove-Module/Import-Module)
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BeginEvent <ScriptBlock>
The actions that should be taken once when setting up the logging.
Can well be used to register helper functions or loading other resources that should be loaded on start only.
Required? false
Position? 3
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-StartEvent <ScriptBlock>
The actions taken at the beginning of each logging cycle.
Typically used to establish connections or do some necessary pre-connections.
Required? false
Position? 4
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-MessageEvent <ScriptBlock>
The actions taken to process individual messages.
The very act of writing logs.
This scriptblock receives a message object (As returned by Get-PSFMessage) as first and only argument.
Under some circumstances, this message may be a $null object, your scriptblock must be able to handle this.
Required? true
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ErrorEvent <ScriptBlock>
The actions taken to process individual error messages.
The very act of writing logs.
This scriptblock receives a message object (As returned by 'Get-PSFMessage -Errors') as first and only
argument.
Under some circumstances, this message may be a $null object, your scriptblock must be able to handle this.
This consists of complex, structured data and may not be suitable to all logging formats.
However all errors are ALWAYS accompanied by a message, making integrating this optional.
Required? false
Position? 6
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-EndEvent <ScriptBlock>
Actions taken when finishing up a logging cycle. Can be used to close connections.
Required? false
Position? 7
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-FinalEvent <ScriptBlock>
Final action to take when the logging terminates.
This should release all resources reserved.
This event will fire when:
- The console is being closed
- The logging script is stopped / killed
- The logging provider is disabled
Required? false
Position? 8
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-ConfigurationParameters <ScriptBlock>
The function Set-PSFLoggingProvider can be used to configure this logging provider.
Using this parameter it is possible to register dynamic parameters when configuring your provider.
Required? false
Position? 9
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-ConfigurationScript <ScriptBlock>
When using Set-PSFLoggingProvider, this script can be used to input given by the dynamic parameters generated
by the -ConfigurationParameters parameter.
Required? false
Position? 10
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-IsInstalledScript <ScriptBlock>
A scriptblock verifying that all prerequisites are properly installed.
Required? false
Position? 11
Default value { $true }
Accept pipeline input? false
Accept wildcard characters? false
-InstallationScript <ScriptBlock>
A scriptblock performing the installation of the provider's prerequisites.
Used by Install-PSFProvider in conjunction with the script provided by -InstallationParameters
Required? false
Position? 12
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-InstallationParameters <ScriptBlock>
A scriptblock returning dynamic parameters that are offered when running Install-PSFprovider.
Those can then be used by the installation scriptblock specified in the aptly named '-InstallationScript'
parameter.
Required? false
Position? 13
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-ConfigurationSettings <ScriptBlock>
This is executed before actually registering the scriptblock.
It allows you to include any logic you wish, but it is specifically designed for configuration settings using
Set-PSFConfig with the '-Initialize' parameter.
Required? false
Position? 14
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EnableException [<SwitchParameter>]
This parameters disables user-friendly warnings and enables the throwing of exceptions.
This is less user friendly, but allows catching exceptions in calling scripts.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Register-PSFLoggingProvider -Name "filesystem" -Enabled $true -RegistrationEvent $registrationEvent
-BeginEvent $begin_event -StartEvent $start_event -MessageEvent $message_Event -ErrorEvent $error_Event -EndEvent
$end_event -FinalEvent $final_event -ConfigurationParameters $configurationParameters -ConfigurationScript
$configurationScript -IsInstalledScript $isInstalledScript -InstallationScript $installationScript
-InstallationParameters $installationParameters -ConfigurationSettings $configuration_Settings
Registers the filesystem provider, providing events for every single occasion.
RELATED LINKS
SYNOPSIS
Registers a new logging provider to the PSFramework logging system.
SYNTAX
Register-PSFLoggingProvider [-Name] <String> [-Enabled] [[-RegistrationEvent] <ScriptBlock>] [[-BeginEvent]
<ScriptBlock>] [[-StartEvent] <ScriptBlock>] [-MessageEvent] <ScriptBlock> [[-ErrorEvent] <ScriptBlock>]
[[-EndEvent] <ScriptBlock>] [[-FinalEvent] <ScriptBlock>] [[-ConfigurationParameters] <ScriptBlock>]
[[-ConfigurationScript] <ScriptBlock>] [[-IsInstalledScript] <ScriptBlock>] [[-InstallationScript] <ScriptBlock>]
[[-InstallationParameters] <ScriptBlock>] [[-ConfigurationSettings] <ScriptBlock>] [-EnableException]
[<CommonParameters>]
DESCRIPTION
This function registers all components of the PSFramework logging provider systems.
It allows you to define your own logging destination and configuration and tie them into the default logging
system.
In order to properly utilize its power, it becomes necessary to understand how the logging works beneath the
covers:
- On Start of the logging script, it runs a one-time scriptblock per enabled provider (this will also occur when
later enabling a provider)
- Thereafter the script will continue, logging in cycles of Start > Log all Messages > Log all Errors > End
Each of those steps has its own event, allowing for fine control over what happens where.
- Finally, on shutdown of a provider it again offers an option to execute some code (to dispose/free resources in
use)
All providers share the same scope for the execution of ALL of those actions/scriptblocks!
This makes it important to give your variables/functions a unique name, in order to avoid conflicts.
General Guideline:
- All variables should start with the name of the provider and an underscore. Example: $filesystem_root
- All functions should use the name of the provider as prefix. Example: Clean-FileSystemErrorXml
A simple implementation example can be seen with the FileSystem provider, stored in the module folder:
internal/loggingProvider/filesystem.provider.ps1
PARAMETERS
-Name <String>
A unique name for your provider. Registering a provider under a name already registered, NOTHING will happen.
This function will instead silently terminate.
Required? true
Position? 1
Default value
Accept pipeline input? false
Accept wildcard characters? false
-Enabled [<SwitchParameter>]
Setting this will enable the provider on registration.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
-RegistrationEvent <ScriptBlock>
Scriptblock that should be executed on registration.
This allows you to perform installation actions synchronously, with direct user interaction.
At the same time, by adding it as this parameter, it will only performed on the initial registration, rather
than every time the provider is registered (runspaces, Remove-Module/Import-Module)
Required? false
Position? 2
Default value
Accept pipeline input? false
Accept wildcard characters? false
-BeginEvent <ScriptBlock>
The actions that should be taken once when setting up the logging.
Can well be used to register helper functions or loading other resources that should be loaded on start only.
Required? false
Position? 3
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-StartEvent <ScriptBlock>
The actions taken at the beginning of each logging cycle.
Typically used to establish connections or do some necessary pre-connections.
Required? false
Position? 4
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-MessageEvent <ScriptBlock>
The actions taken to process individual messages.
The very act of writing logs.
This scriptblock receives a message object (As returned by Get-PSFMessage) as first and only argument.
Under some circumstances, this message may be a $null object, your scriptblock must be able to handle this.
Required? true
Position? 5
Default value
Accept pipeline input? false
Accept wildcard characters? false
-ErrorEvent <ScriptBlock>
The actions taken to process individual error messages.
The very act of writing logs.
This scriptblock receives a message object (As returned by 'Get-PSFMessage -Errors') as first and only
argument.
Under some circumstances, this message may be a $null object, your scriptblock must be able to handle this.
This consists of complex, structured data and may not be suitable to all logging formats.
However all errors are ALWAYS accompanied by a message, making integrating this optional.
Required? false
Position? 6
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-EndEvent <ScriptBlock>
Actions taken when finishing up a logging cycle. Can be used to close connections.
Required? false
Position? 7
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-FinalEvent <ScriptBlock>
Final action to take when the logging terminates.
This should release all resources reserved.
This event will fire when:
- The console is being closed
- The logging script is stopped / killed
- The logging provider is disabled
Required? false
Position? 8
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-ConfigurationParameters <ScriptBlock>
The function Set-PSFLoggingProvider can be used to configure this logging provider.
Using this parameter it is possible to register dynamic parameters when configuring your provider.
Required? false
Position? 9
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-ConfigurationScript <ScriptBlock>
When using Set-PSFLoggingProvider, this script can be used to input given by the dynamic parameters generated
by the -ConfigurationParameters parameter.
Required? false
Position? 10
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-IsInstalledScript <ScriptBlock>
A scriptblock verifying that all prerequisites are properly installed.
Required? false
Position? 11
Default value { $true }
Accept pipeline input? false
Accept wildcard characters? false
-InstallationScript <ScriptBlock>
A scriptblock performing the installation of the provider's prerequisites.
Used by Install-PSFProvider in conjunction with the script provided by -InstallationParameters
Required? false
Position? 12
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-InstallationParameters <ScriptBlock>
A scriptblock returning dynamic parameters that are offered when running Install-PSFprovider.
Those can then be used by the installation scriptblock specified in the aptly named '-InstallationScript'
parameter.
Required? false
Position? 13
Default value { }
Accept pipeline input? false
Accept wildcard characters? false
-ConfigurationSettings <ScriptBlock>
This is executed before actually registering the scriptblock.
It allows you to include any logic you wish, but it is specifically designed for configuration settings using
Set-PSFConfig with the '-Initialize' parameter.
Required? false
Position? 14
Default value
Accept pipeline input? false
Accept wildcard characters? false
-EnableException [<SwitchParameter>]
This parameters disables user-friendly warnings and enables the throwing of exceptions.
This is less user friendly, but allows catching exceptions in calling scripts.
Required? false
Position? named
Default value False
Accept pipeline input? false
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Register-PSFLoggingProvider -Name "filesystem" -Enabled $true -RegistrationEvent $registrationEvent
-BeginEvent $begin_event -StartEvent $start_event -MessageEvent $message_Event -ErrorEvent $error_Event -EndEvent
$end_event -FinalEvent $final_event -ConfigurationParameters $configurationParameters -ConfigurationScript
$configurationScript -IsInstalledScript $isInstalledScript -InstallationScript $installationScript
-InstallationParameters $installationParameters -ConfigurationSettings $configuration_Settings
Registers the filesystem provider, providing events for every single occasion.
RELATED LINKS