SimplePSLogger.File/SimplePSLogger.File.psm1

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
<#
.SYNOPSIS
    File logging provider for SimplePSLogger logger
    This provider writes colored messages to the console by using powershell's default Write-* functions
.DESCRIPTION
    TODO: add more details
    More details
 
.PARAMETER Name
    SimplePSLogger action execution id which is used to identify executing action
.PARAMETER Level
    Log level : allowed values are - "verbose", "debug", "information", "warning", "error", "critical", "none"
    TODO : add more infor for each level
.PARAMETER Message
    Log message :
        String - plain text string
        OtherTypes - json serialized string
 
.PARAMETER Config
    Required configuration provided by user
 
.EXAMPLE
    TODO : Add examples
 
.NOTES
    Author: Ganesh Raskar
     
#>

function New-File-Logger {
    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $true, HelpMessage = "Name of the SimplePSLogger instance")]
        [string]
        $Name,
        [Parameter(Mandatory = $false, HelpMessage = "Log level, default value is information")]
        [string]
        $Level,
        [Parameter(Mandatory = $true, HelpMessage = "Log message")]
        [string]
        $Message,
        [Parameter(Mandatory = $false, HelpMessage = "Configuration object")]
        [object]
        $Config
    )

    
    $logMessage = "$((Get-Date).ToUniversalTime().ToString("yyyy/MM/dd HH:mm:ss:ffff tt")) $Name $($Level) $($Message.Trim())"
    
    <#
        TODO : Robust error handling and config validation
    #>

    if (-Not $Config -or -Not $($Config["LiteralFilePath"])) {
        $filePath = Join-Path $([system.io.path]::GetTempPath()) -ChildPath "$Name.log"
        Write-Information "File provider does not have LiteralfilePath configured, switching to auto generated file here $filepath"
    }
    else {
        $filePath = $($Config["LiteralFilePath"])
    }
    
    Add-Content $filePath $logMessage -Encoding 'UTF8'
}

Export-ModuleMember -Function New-File-Logger
# SIG # Begin signature block
# MIIYYQYJKoZIhvcNAQcCoIIYUjCCGE4CAQExCzAJBgUrDgMCGgUAMGkGCisGAQQB
# gjcCAQSgWzBZMDQGCisGAQQBgjcCAR4wJgIDAQAABBAfzDtgWUsITrck0sYpfvNR
# AgEAAgEAAgEAAgEAAgEAMCEwCQYFKw4DAhoFAAQUIiGOgO01IenDsJ5Nse2e5ffB
# QAmgghKzMIIFcDCCA1igAwIBAgIQZDtcNubuNpVEfXOVHbciTzANBgkqhkiG9w0B
# AQsFADBQMSUwIwYDVQQDDBxHYW5lc2ggUmFza2FyIFNpbXBsZVBTTG9nZ2VyMScw
# JQYJKoZIhvcNAQkBFhhnYW5lc2hyYXNrYXJAb3V0bG9vay5jb20wHhcNMjAwNzA0
# MTgzMjE0WhcNMjEwNzA0MTg1MjE0WjBQMSUwIwYDVQQDDBxHYW5lc2ggUmFza2Fy
# IFNpbXBsZVBTTG9nZ2VyMScwJQYJKoZIhvcNAQkBFhhnYW5lc2hyYXNrYXJAb3V0
# bG9vay5jb20wggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQCywhH9ot8P
# 9i7rClMbjRwIH1DeVotpNCscFvcSqEbMo3AtJ0WFOb13Xt/g1d0axBa3DvriedVR
# KF2AD0U8jGIsToPBnIdBKVXQ72CN+i1BHrqu9DOI7+csE0hVFAqYCv7qIXgAGued
# FQOe1oD5q3H3GlzLDfwhk/cdLCt+WEgzWdtTca8kirNoRftSNrl7R6MEEZIRY9d4
# /J1RhjKoDfyWn2+8KcAtAkLOND5yjRPzY+jM2IEe4uELQbzbdYASmJYZq6h8Dy/6
# w/A3LRpi06kzceTao8xyUax3K11Sw/QkljLr2BKpwO8JNMMUTLNx5mAZBRyfvFvG
# dZDjnnIrK2vr/qBB+cGb5S7son0N90Xc0yXyDWqAEQqMT4C0jX8FDGv//ZafbsHj
# wSEV//L8E6GBP76QxfX+TTZIik0wy52Gf79ok1v3s7PgE2SyaE+iY0klYzo0bBKK
# B2MPTQ2dmRy9peTzeC+KP7DWxm/9fF7OjsXY2FdWnIQL/qW6YEN5g+c+mTV/8OqB
# w3xiK5WUHsd39GAGKNaHfKdUQ0nPrzDdsxGlwBlqmX+kPj7b+hZR+NBiwQLyPEk+
# qK3YKNF182GLjUj0uH5FsGrT6d+UteyB2OibxH3I2rN/KKHqQFKbC8Lbw4SbY154
# pLDc5Tfn+4GcHbpnN8pjEIsOF6Efa3/yxQIDAQABo0YwRDAOBgNVHQ8BAf8EBAMC
# B4AwEwYDVR0lBAwwCgYIKwYBBQUHAwMwHQYDVR0OBBYEFJuHGRIu8rLatkA/b+kP
# R1QXu0RlMA0GCSqGSIb3DQEBCwUAA4ICAQAjr84JfMOG6r3jzwLl6z0nKmL5faE+
# 02U2QIcOHOlHnXOtMBmLm4IX91gOG93rBCB94GRVOUFMhAx1xkLa6moHIimfyaEU
# 2UoLKVNtqrMymq6ZlQ/Yg8tPMEZfDN9wq/3EewJu+OvQvkMPRuC4LTEZs2GIHQbJ
# urAzp7YT7agchAo/lm65Alg4e8QNALPcx3hkwuZtYs/FI6PEqlzpFF5RFy8Prys8
# gO4yAR3BHrz5Ri5wj9QD54kLdCvw50jJwWu+d4no2kMcKa90zjie4RBS7v4LwLdS
# Yg1RMKT9yE53ch7lef/0Oj/m09mnIp+KVhtb0pe3ZOCDVvl7MCq7JWj/IGa1SMOP
# 1BPxaP4FBr3vB6eE4WVyOETtT3heJScETmMXlDl7MQgc8KXz2B6iOPYMkblt3d7W
# jtwIRrkujL468qzmxrlPTcEPKLqpfHaYGD3lHfwQm59KBEAqiqf/Rrya3uQmkG+a
# pNoG9sWRF/M0BsOnRj31gpJqysvrHRlIf2XQebQqWY3ztVDsht+GQ8kEZnDic6j7
# oP6eSdjVG/Itv7w8ZHbqeRbXmE5mbzw1kTl3ZCPsPgmIU5r/PMcsH6H+aWJNwann
# 5f+MZfM1Yozmot2z8Z65AnWB+0EfLv97Y70s1TWGaUsFk1e36f2sh/bLlSIFjcaG
# 8DViFGT0BzLX4jCCBmowggVSoAMCAQICEAMBmgI6/1ixa9bV6uYX8GYwDQYJKoZI
# hvcNAQEFBQAwYjELMAkGA1UEBhMCVVMxFTATBgNVBAoTDERpZ2lDZXJ0IEluYzEZ
# MBcGA1UECxMQd3d3LmRpZ2ljZXJ0LmNvbTEhMB8GA1UEAxMYRGlnaUNlcnQgQXNz
# dXJlZCBJRCBDQS0xMB4XDTE0MTAyMjAwMDAwMFoXDTI0MTAyMjAwMDAwMFowRzEL
# MAkGA1UEBhMCVVMxETAPBgNVBAoTCERpZ2lDZXJ0MSUwIwYDVQQDExxEaWdpQ2Vy
# dCBUaW1lc3RhbXAgUmVzcG9uZGVyMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB
# CgKCAQEAo2Rd/Hyz4II14OD2xirmSXU7zG7gU6mfH2RZ5nxrf2uMnVX4kuOe1Vpj
# WwJJUNmDzm9m7t3LhelfpfnUh3SIRDsZyeX1kZ/GFDmsJOqoSyyRicxeKPRktlC3
# 9RKzc5YKZ6O+YZ+u8/0SeHUOplsU/UUjjoZEVX0YhgWMVYd5SEb3yg6Np95OX+Ko
# ti1ZAmGIYXIYaLm4fO7m5zQvMXeBMB+7NgGN7yfj95rwTDFkjePr+hmHqH7P7IwM
# Nlt6wXq4eMfJBi5GEMiN6ARg27xzdPpO2P6qQPGyznBGg+naQKFZOtkVCVeZVjCT
# 88lhzNAIzGvsYkKRrALA76TwiRGPdwIDAQABo4IDNTCCAzEwDgYDVR0PAQH/BAQD
# AgeAMAwGA1UdEwEB/wQCMAAwFgYDVR0lAQH/BAwwCgYIKwYBBQUHAwgwggG/BgNV
# HSAEggG2MIIBsjCCAaEGCWCGSAGG/WwHATCCAZIwKAYIKwYBBQUHAgEWHGh0dHBz
# Oi8vd3d3LmRpZ2ljZXJ0LmNvbS9DUFMwggFkBggrBgEFBQcCAjCCAVYeggFSAEEA
# bgB5ACAAdQBzAGUAIABvAGYAIAB0AGgAaQBzACAAQwBlAHIAdABpAGYAaQBjAGEA
# dABlACAAYwBvAG4AcwB0AGkAdAB1AHQAZQBzACAAYQBjAGMAZQBwAHQAYQBuAGMA
# ZQAgAG8AZgAgAHQAaABlACAARABpAGcAaQBDAGUAcgB0ACAAQwBQAC8AQwBQAFMA
# IABhAG4AZAAgAHQAaABlACAAUgBlAGwAeQBpAG4AZwAgAFAAYQByAHQAeQAgAEEA
# ZwByAGUAZQBtAGUAbgB0ACAAdwBoAGkAYwBoACAAbABpAG0AaQB0ACAAbABpAGEA
# YgBpAGwAaQB0AHkAIABhAG4AZAAgAGEAcgBlACAAaQBuAGMAbwByAHAAbwByAGEA
# dABlAGQAIABoAGUAcgBlAGkAbgAgAGIAeQAgAHIAZQBmAGUAcgBlAG4AYwBlAC4w
# CwYJYIZIAYb9bAMVMB8GA1UdIwQYMBaAFBUAEisTmLKZB+0e36K+Vw0rZwLNMB0G
# A1UdDgQWBBRhWk0ktkkynUoqeRqDS/QeicHKfTB9BgNVHR8EdjB0MDigNqA0hjJo
# dHRwOi8vY3JsMy5kaWdpY2VydC5jb20vRGlnaUNlcnRBc3N1cmVkSURDQS0xLmNy
# bDA4oDagNIYyaHR0cDovL2NybDQuZGlnaWNlcnQuY29tL0RpZ2lDZXJ0QXNzdXJl
# ZElEQ0EtMS5jcmwwdwYIKwYBBQUHAQEEazBpMCQGCCsGAQUFBzABhhhodHRwOi8v
# b2NzcC5kaWdpY2VydC5jb20wQQYIKwYBBQUHMAKGNWh0dHA6Ly9jYWNlcnRzLmRp
# Z2ljZXJ0LmNvbS9EaWdpQ2VydEFzc3VyZWRJRENBLTEuY3J0MA0GCSqGSIb3DQEB
# BQUAA4IBAQCdJX4bM02yJoFcm4bOIyAPgIfliP//sdRqLDHtOhcZcRfNqRu8WhY5
# AJ3jbITkWkD73gYBjDf6m7GdJH7+IKRXrVu3mrBgJuppVyFdNC8fcbCDlBkFazWQ
# EKB7l8f2P+fiEUGmvWLZ8Cc9OB0obzpSCfDscGLTYkuw4HOmksDTjjHYL+NtFxMG
# 7uQDthSr849Dp3GdId0UyhVdkkHa+Q+B0Zl0DSbEDn8btfWg8cZ3BigV6diT5VUW
# 8LsKqxzbXEgnZsijiwoc5ZXarsQuWaBh3drzbaJh6YoLbewSGL33VVRAA5Ira8JR
# wgpIr7DUbuD0FAo6G+OPPcqvao173NhEMIIGzTCCBbWgAwIBAgIQBv35A5YDreoA
# Cus/J7u6GzANBgkqhkiG9w0BAQUFADBlMQswCQYDVQQGEwJVUzEVMBMGA1UEChMM
# RGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3d3cuZGlnaWNlcnQuY29tMSQwIgYDVQQD
# ExtEaWdpQ2VydCBBc3N1cmVkIElEIFJvb3QgQ0EwHhcNMDYxMTEwMDAwMDAwWhcN
# MjExMTEwMDAwMDAwWjBiMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQg
# SW5jMRkwFwYDVQQLExB3d3cuZGlnaWNlcnQuY29tMSEwHwYDVQQDExhEaWdpQ2Vy
# dCBBc3N1cmVkIElEIENBLTEwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIB
# AQDogi2Z+crCQpWlgHNAcNKeVlRcqcTSQQaPyTP8TUWRXIGf7Syc+BZZ3561JBXC
# mLm0d0ncicQK2q/LXmvtrbBxMevPOkAMRk2T7It6NggDqww0/hhJgv7HxzFIgHwe
# og+SDlDJxofrNj/YMMP/pvf7os1vcyP+rFYFkPAyIRaJxnCI+QWXfaPHQ90C6Ds9
# 7bFBo+0/vtuVSMTuHrPyvAwrmdDGXRJCgeGDboJzPyZLFJCuWWYKxI2+0s4Grq2E
# b0iEm09AufFM8q+Y+/bOQF1c9qjxL6/siSLyaxhlscFzrdfx2M8eCnRcQrhofrfV
# dwonVnwPYqQ/MhRglf0HBKIJAgMBAAGjggN6MIIDdjAOBgNVHQ8BAf8EBAMCAYYw
# OwYDVR0lBDQwMgYIKwYBBQUHAwEGCCsGAQUFBwMCBggrBgEFBQcDAwYIKwYBBQUH
# AwQGCCsGAQUFBwMIMIIB0gYDVR0gBIIByTCCAcUwggG0BgpghkgBhv1sAAEEMIIB
# pDA6BggrBgEFBQcCARYuaHR0cDovL3d3dy5kaWdpY2VydC5jb20vc3NsLWNwcy1y
# ZXBvc2l0b3J5Lmh0bTCCAWQGCCsGAQUFBwICMIIBVh6CAVIAQQBuAHkAIAB1AHMA
# ZQAgAG8AZgAgAHQAaABpAHMAIABDAGUAcgB0AGkAZgBpAGMAYQB0AGUAIABjAG8A
# bgBzAHQAaQB0AHUAdABlAHMAIABhAGMAYwBlAHAAdABhAG4AYwBlACAAbwBmACAA
# dABoAGUAIABEAGkAZwBpAEMAZQByAHQAIABDAFAALwBDAFAAUwAgAGEAbgBkACAA
# dABoAGUAIABSAGUAbAB5AGkAbgBnACAAUABhAHIAdAB5ACAAQQBnAHIAZQBlAG0A
# ZQBuAHQAIAB3AGgAaQBjAGgAIABsAGkAbQBpAHQAIABsAGkAYQBiAGkAbABpAHQA
# eQAgAGEAbgBkACAAYQByAGUAIABpAG4AYwBvAHIAcABvAHIAYQB0AGUAZAAgAGgA
# ZQByAGUAaQBuACAAYgB5ACAAcgBlAGYAZQByAGUAbgBjAGUALjALBglghkgBhv1s
# AxUwEgYDVR0TAQH/BAgwBgEB/wIBADB5BggrBgEFBQcBAQRtMGswJAYIKwYBBQUH
# MAGGGGh0dHA6Ly9vY3NwLmRpZ2ljZXJ0LmNvbTBDBggrBgEFBQcwAoY3aHR0cDov
# L2NhY2VydHMuZGlnaWNlcnQuY29tL0RpZ2lDZXJ0QXNzdXJlZElEUm9vdENBLmNy
# dDCBgQYDVR0fBHoweDA6oDigNoY0aHR0cDovL2NybDMuZGlnaWNlcnQuY29tL0Rp
# Z2lDZXJ0QXNzdXJlZElEUm9vdENBLmNybDA6oDigNoY0aHR0cDovL2NybDQuZGln
# aWNlcnQuY29tL0RpZ2lDZXJ0QXNzdXJlZElEUm9vdENBLmNybDAdBgNVHQ4EFgQU
# FQASKxOYspkH7R7for5XDStnAs0wHwYDVR0jBBgwFoAUReuir/SSy4IxLVGLp6ch
# nfNtyA8wDQYJKoZIhvcNAQEFBQADggEBAEZQPsm3KCSnOB22WymvUs9S6TFHq1Zc
# e9UNC0Gz7+x1H3Q48rJcYaKclcNQ5IK5I9G6OoZyrTh4rHVdFxc0ckeFlFbR67s2
# hHfMJKXzBBlVqefj56tizfuLLZDCwNK1lL1eT7EF0g49GqkUW6aGMWKoqDPkmzmn
# xPXOHXh2lCVz5Cqrz5x2S+1fwksW5EtwTACJHvzFebxMElf+X+EevAJdqP77BzhP
# DcZdkbkPZ0XN1oPt55INjbFpjE/7WeAjD9KqrgB87pxCDs+R1ye3Fu4Pw718CqDu
# LAhVhSK46xgaTfwqIa1JMYNHlXdx3LEbS0scEJx3FMGdTy9alQgpECYxggUYMIIF
# FAIBATBkMFAxJTAjBgNVBAMMHEdhbmVzaCBSYXNrYXIgU2ltcGxlUFNMb2dnZXIx
# JzAlBgkqhkiG9w0BCQEWGGdhbmVzaHJhc2thckBvdXRsb29rLmNvbQIQZDtcNubu
# NpVEfXOVHbciTzAJBgUrDgMCGgUAoHgwGAYKKwYBBAGCNwIBDDEKMAigAoAAoQKA
# ADAZBgkqhkiG9w0BCQMxDAYKKwYBBAGCNwIBBDAcBgorBgEEAYI3AgELMQ4wDAYK
# KwYBBAGCNwIBFTAjBgkqhkiG9w0BCQQxFgQUFTDay3BWhML8aZ+lgjHG/5iCMiww
# DQYJKoZIhvcNAQEBBQAEggIAMR6zpB81jlWQ5W42bVebopAxr9+y0zQQzWGmDIfZ
# zbxQmhO1lQ0KLSQkiTgb3fi8j356LNmFD2VBUwdKbRW6GE1IxQa8JR43Zh/zI5+3
# rS378GD+ZSJ7Sl3cQvEXw4ow3oqynQNIvl2wgVG2sMBltRSyNbxc/4RbKDpPXRC+
# z7KUHA3TmTCfDaDQNcEE4XGdDX/JHr4TnZ+2Q9NkXNEhb3Uh3MorDp6Cf91C6s6y
# 4CVIg3sxBZS4MNpT/RZn9N2l1X1LrWHam4CgqSz6ZronjiGIuMn0zrZMkfihBi03
# y9ExY8uH8v8TsXMDFkTy+JL7sbCpSYqx0MR13WhUhX5cvu9UipUC5m3c6Wkd3q8d
# aeQmV8u86wOi8GFeipo3e3CtomwfefrG/bSyA2EIix8tvk/2OAoU/3Z7JpXf2UIU
# //x6HsIvxmm827LlG12wJ2affG036UTRymaeQWrsN4KM/4UpQIbXKuB5sShqgR4X
# agItZA4JzCkrVo7Llq6dc+mtnBrGhmbUEuA+xyxSkef0zlD5m1deMaXzsfoZbESd
# S7Be5eSPBf+oe3F0M7jxBuMHqje/rvn3freMRBzRuS3RY6wOaIeP3XWd5AQlt+eh
# QjOid/yYfzJJTgAhV3SL3/rEXu0+LTndViIY3FQpjgn0+wGno5xaipMZFVpNiUDu
# F1yhggIPMIICCwYJKoZIhvcNAQkGMYIB/DCCAfgCAQEwdjBiMQswCQYDVQQGEwJV
# UzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMRkwFwYDVQQLExB3d3cuZGlnaWNlcnQu
# Y29tMSEwHwYDVQQDExhEaWdpQ2VydCBBc3N1cmVkIElEIENBLTECEAMBmgI6/1ix
# a9bV6uYX8GYwCQYFKw4DAhoFAKBdMBgGCSqGSIb3DQEJAzELBgkqhkiG9w0BBwEw
# HAYJKoZIhvcNAQkFMQ8XDTIwMDcyNzE2MjEwMlowIwYJKoZIhvcNAQkEMRYEFKmf
# e6/fYc85xrd34W0rUwReJHxBMA0GCSqGSIb3DQEBAQUABIIBAFYvrVpprlDmQiBH
# bMroxYXdFvQF/SQsWhGcOKlre/I2xJuArOoGFyOYgMye94w0Jgyv0VqLVgm1DoRM
# oS/r0qeTjyt9iemjCH9w28TJFLA6qpwFoDGKrb2wUpmk8Q/UkA6djW7kPLxUkd3+
# 9gh3yUMpNN70bOP7NtvWfCJgyG+rziQnylbfnztzODwU/dJCDEdzHoKJhKLhY5wO
# 0dykQUdaTXqUVdksEN86jzAn4YFoKK7nICWyCUuEkk4jLCikhy3nIUY4LUdFhH4o
# lYSOhTIULWT+PsyD6XIj6PMto1EjT+zynQN0VledTyJBGI+RcMnYOEhEnGAfPb+U
# W+stuAA=
# SIG # End signature block