functions/logging/Set-PSFLoggingProvider.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
function Set-PSFLoggingProvider
{
<#
    .SYNOPSIS
        Configures a logging provider.
     
    .DESCRIPTION
        This command allows configuring the way a logging provider works.
        This grants the ability to ...
        - Enable / Disable a provider
        - Set additional parameters defined by the provider (each provider may implement its own settings, exposed through dynamic parameters)
        - Configure filters about what messages get sent to a given provider.
     
    .PARAMETER Name
        The name of the provider to configure
     
    .PARAMETER InstanceName
        A description of the InstanceName parameter.
     
    .PARAMETER Enabled
        Whether the provider should be enabled or disabled.
     
    .PARAMETER IncludeModules
        Only messages from modules listed here will be logged.
        Exact match only, an empty list results in all modules being logged.
     
    .PARAMETER ExcludeModules
        Messages from excluded modules will not be logged using this provider.
        Overrides -IncludeModules in case of overlap.
     
    .PARAMETER IncludeFunctions
        Only messages from functions that match at least one entry noted here will be logged.
        Uses wildcard expressions.
     
    .PARAMETER ExcludeFunctions
        Messages from functions that match at least one entry noted here will NOT be logged.
        Uses wildcard expressions.
     
    .PARAMETER IncludeRunspaces
        Only messages that come from one of the defined runspaces will be logged.
     
    .PARAMETER ExcludeRunspaces
        Messages that come from one of the defined runspaces will NOT be logged.
     
    .PARAMETER IncludeTags
        Only messages containing the listed tags will be logged.
        Exact match only, only a single match is required for a message to qualify.
     
    .PARAMETER ExcludeTags
        Messages containing any of the listed tags will not be logged.
        Overrides -IncludeTags in case of overlap.
     
    .PARAMETER MinLevel
        The minimum level of a message that will be logged.
        Note: The lower the message level, the MORE important it is.
        Levels range from 1 through 9:
        - InternalComment: 9
        - Debug: 8
        - Verbose: 5
        - Host: 2
        - Critical: 1
        The level "Warning" is not represented on this scale.
     
    .PARAMETER MaxLevel
        The maximum level of a message that will be logged.
        Note: The lower the message level, the MORE important it is.
        Levels range from 1 through 9:
        - InternalComment: 9
        - Debug: 8
        - Verbose: 5
        - Host: 2
        - Critical: 1
        The level "Warning" is not represented on this scale.
     
    .PARAMETER RequiresInclude
        By default, messages will be written to a logging provider, unless a specific exclude rule was met or any include rule was not met.
        That means, if no exclude and include rules exist at a given time, all messages will be written to the logging provider instance.
        Setting this to true will instead require at least one include rule to exist - and be met - before logging a message.
        This is designed for in particular for runspace-bound logging providers, which might at runtime swiftly gain or lose included runspaces.
     
    .PARAMETER ExcludeWarning
        Whether to exclude warnings from the logging provider / instance.
     
    .PARAMETER EnableException
        This parameters disables user-friendly warnings and enables the throwing of exceptions.
        This is less user friendly, but allows catching exceptions in calling scripts.
     
    .EXAMPLE
        PS C:\> Set-PSFLoggingProvider -Name filesystem -Enabled $false
         
        Disables the filesystem provider.
     
    .EXAMPLE
        PS C:\> Set-PSFLoggingProvider -Name filesystem -ExcludeModules "PSFramework"
         
        Prevents all messages from the PSFramework module to be logged to the file system
#>

    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseShouldProcessForStateChangingFunctions", "")]
    [CmdletBinding(HelpUri = 'https://psframework.org/documentation/commands/PSFramework/Set-PSFLoggingProvider')]
    param (
        [Parameter(Mandatory = $true)]
        [ValidateNotNullOrEmpty()]
        [Alias('Provider', 'ProviderName')]
        [string]
        $Name,
        
        [string]
        $InstanceName,
        
        [bool]
        $Enabled,
        
        [string[]]
        $IncludeModules,
        
        [string[]]
        $ExcludeModules,
        
        [string[]]
        $IncludeFunctions,
        
        [string[]]
        $ExcludeFunctions,
        
        [guid[]]
        $IncludeRunspaces,
        
        [guid[]]
        $ExcludeRunspaces,
        
        [string[]]
        $IncludeTags,
        
        [string[]]
        $ExcludeTags,
        
        [ValidateRange(1,9)]
        [int]
        $MinLevel,
        
        [ValidateRange(1, 9)]
        [int]
        $MaxLevel,
        
        [switch]
        $RequiresInclude,
        
        [switch]
        $ExcludeWarning,
        
        [switch]
        $EnableException
    )
    
    dynamicparam
    {
        if ($Name -and ([PSFramework.Logging.ProviderHost]::Providers.ContainsKey($Name)))
        {
            $provider = [PSFramework.Logging.ProviderHost]::Providers[$Name]
            $results = $provider.ConfigurationParameters.InvokeGlobal() | Where-Object { $_ -is [System.Management.Automation.RuntimeDefinedParameterDictionary] }
            if (-not $results) { $results = New-Object System.Management.Automation.RuntimeDefinedParameterDictionary }
            
            #region Process V2 Properties
            # Since V1 Providers do not have the property, this loop will never execute for them
            foreach ($propertyName in $provider.InstanceProperties)
            {
                $parameterAttribute = New-Object System.Management.Automation.ParameterAttribute
                $parameterAttribute.ParameterSetName = '__AllParameterSets'
                $attributesCollection = New-Object System.Collections.ObjectModel.Collection[System.Attribute]
                $attributesCollection.Add($parameterAttribute)
                $RuntimeParam = New-Object System.Management.Automation.RuntimeDefinedParameter($propertyName, [object], $attributesCollection)
                
                $results.Add($propertyName, $RuntimeParam)
            }
            #endregion Process V2 Properties
            
            $results
        }
    }
    
    begin
    {
        if (-not ([PSFramework.Logging.ProviderHost]::Providers.ContainsKey($Name)))
        {
            Stop-PSFFunction -String 'Set-PSFLoggingProvider.Provider.NotFound' -StringValues $Name -EnableException $EnableException -Category InvalidArgument -Target $Name
            return
        }
        
        $provider = [PSFramework.Logging.ProviderHost]::Providers[$Name]
        if ($InstanceName -and $provider.ProviderVersion -eq 'Version_1')
        {
            Stop-PSFFunction -String 'Set-PSFLoggingProvider.Provider.V1NoInstance' -StringValues $Name -EnableException $EnableException -Category InvalidArgument -Target $Name
            return
        }
        
        [PSFramework.Utility.UtilityHost]::ImportScriptBlock($provider.IsInstalledScript, $true)
        
        if ((-not $provider.Enabled) -and (-not $provider.IsInstalledScript.InvokeGlobal()) -and $Enabled)
        {
            Stop-PSFFunction -String 'Set-PSFLoggingProvider.Provider.NotInstalled' -StringValues $Name -EnableException $EnableException -Category InvalidOperation -Target $Name
            return
        }
    }
    process
    {
        if (Test-PSFFunctionInterrupt) { return }
        
        $provider.ConfigurationScript.InvokeGlobal($PSBoundParameters)
        
        $instanceAffix = ''
        if ($InstanceName -and ($InstanceName -ne "Default")) { $instanceAffix = "$InstanceName." }
        
        #region V2 Instance Properties
        foreach ($propertyName in $provider.InstanceProperties)
        {
            $value = $provider.ConfigurationDefaultValues[$propertyName]
            $initialize = $true
            if (Test-PSFParameterBinding -ParameterName $propertyName)
            {
                $initialize = $false
                $value = $PSBoundParameters[$propertyName]
            }
            
            Set-PSFConfig -FullName "$($provider.ConfigurationRoot).$($instanceAffix)$($propertyName)" -Value $value -Initialize:$initialize
        }
        #endregion V2 Instance Properties
        
        #region Filter Configuration
        $setProperty = -not $InstanceName -or $InstanceName -eq "Default"
        if (Test-PSFParameterBinding -ParameterName "IncludeModules")
        {
            if ($setProperty) { $provider.IncludeModules = $IncludeModules }
            Set-PSFConfig -FullName "LoggingProvider.$($provider.Name).$($instanceAffix)IncludeModules" -Value $IncludeModules
        }
        if (Test-PSFParameterBinding -ParameterName "ExcludeModules")
        {
            if ($setProperty) { $provider.ExcludeModules = $ExcludeModules }
            Set-PSFConfig -FullName "LoggingProvider.$($provider.Name).$($instanceAffix)ExcludeModules" -Value $ExcludeModules
        }
        
        if (Test-PSFParameterBinding -ParameterName "IncludeFunctions")
        {
            if ($setProperty) { $provider.IncludeFunctions = $IncludeFunctions }
            Set-PSFConfig -FullName "LoggingProvider.$($provider.Name).$($instanceAffix)IncludeFunctions" -Value $IncludeFunctions
        }
        if (Test-PSFParameterBinding -ParameterName "ExcludeFunctions")
        {
            if ($setProperty) { $provider.ExcludeFunctions = $ExcludeFunctions }
            Set-PSFConfig -FullName "LoggingProvider.$($provider.Name).$($instanceAffix)ExcludeFunctions" -Value $ExcludeFunctions
        }
        
        if (Test-PSFParameterBinding -ParameterName "IncludeRunspaces")
        {
            if ($setProperty) { $provider.IncludeRunspaces = $IncludeRunspaces }
            Set-PSFConfig -FullName "LoggingProvider.$($provider.Name).$($instanceAffix)IncludeRunspaces" -Value $IncludeRunspaces
        }
        if (Test-PSFParameterBinding -ParameterName "ExcludeRunspaces")
        {
            if ($setProperty) { $provider.ExcludeRunspaces = $ExcludeRunspaces }
            Set-PSFConfig -FullName "LoggingProvider.$($provider.Name).$($instanceAffix)ExcludeRunspaces" -Value $ExcludeRunspaces
        }
        
        if (Test-PSFParameterBinding -ParameterName "IncludeTags")
        {
            if ($setProperty) { $provider.IncludeTags = $IncludeTags }
            Set-PSFConfig -FullName "LoggingProvider.$($provider.Name).$($instanceAffix)IncludeTags" -Value $IncludeTags
        }
        if (Test-PSFParameterBinding -ParameterName "ExcludeTags")
        {
            if ($setProperty) { $provider.ExcludeTags = $ExcludeTags }
            Set-PSFConfig -FullName "LoggingProvider.$($provider.Name).$($instanceAffix)ExcludeTags" -Value $ExcludeTags
        }
        
        if ($MinLevel)
        {
            if ($setProperty) { $provider.MinLevel = $MinLevel }
            Set-PSFConfig -FullName "LoggingProvider.$($provider.Name).$($instanceAffix)MinLevel" -Value $MinLevel
        }
        if ($MaxLevel)
        {
            if ($setProperty) { $provider.MaxLevel = $MaxLevel }
            Set-PSFConfig -FullName "LoggingProvider.$($provider.Name).$($instanceAffix)MaxLevel" -Value $MaxLevel
        }
        if (Test-PSFParameterBinding -ParameterName "ExcludeWarning")
        {
            if ($setProperty) { $provider.IncludeWarning = -not $ExcludeWarning }
            Set-PSFConfig -FullName "LoggingProvider.$($provider.Name).$($instanceAffix)IncludeWarning" -Value (-not $ExcludeWarning)
        }
        
        # V2 Only
        if (Test-PSFParameterBinding -ParameterName "RequiresInclude"){
            Set-PSFConfig -FullName "LoggingProvider.$($provider.Name).$($instanceAffix)RequiresInclude" -Value $RequiresInclude
        }
        #endregion Filter Configuration
        
        if (Test-PSFParameterBinding -ParameterName "Enabled")
        {
            Set-PSFConfig -FullName "LoggingProvider.$($provider.Name).$($instanceAffix)Enabled" -Value $Enabled
            if ($provider.ProviderVersion -eq 'Version_1') { $provider.Enabled = $Enabled }
            elseif ($provider.Instances[$InstanceName])
            {
                $provider.Instances[$InstanceName].Enabled = $Enabled
            }
        }
    }
}