EZLog.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
#Requires -Version 2.0
$ErrorActionPreference = 'Stop'

Add-Type -TypeDefinition @"
    public enum MsgCategory
    {
       INF = 0,
       WAR = 1,
       ERR = 2
    }
"@


Function Write-Log
{
<#
.Synopsis
   Utility cmdlet to write logs to disk in an easy and pragmatic way.
 
.DESCRIPTION
   This cmdlet allows to write timestamped and nice formatted logs with a header and footer.
   It also allows to specify if the log entry being written is an info, a warning or an error.
    
   The header contains the following information :
       - full script path of the caller,
       - account under the script was run,
       - computer name of the machine whose executed the script,
       - and more...
   The footer contains the elapsed time from the beginning of the log session.
 
.PARAMETER Header
    Mandatory switch to start a log session.
 
.PARAMETER Category
    Category can be one of the following value : INF, WAR, ERR
 
.PARAMETER Message
    Specify the content of the data to log.
 
.PARAMETER Footer
    Mandatory switch to end a log session. If you omit to close your log session, you won't know how much time
    your script was running.
 
.EXAMPLE
   First thing to do is write a header and define a log file where the data will be written.
 
   PS > Write-Log -Header -LogFile C:\logs\mylogfile.log
    
   Next, anywhere in your script when you need to write a log, do one of the folowing command:
 
   PS > Write-Log -Category INF -Message 'This is an info to be written in the log file'
   PS > Write-Log -Category WAR -Message 'This is a warning to be written in the log file'
   PS > Write-Log -Category ERR -Message 'This is an error to be written in the log file'
 
   Finaly, to close your logfile you need to write a footer, just do that:
 
   PS > Write-Log -Footer
 
.EXAMPLE
   If you want to see the logs in the PowerShell console whereas they are still written to disk,
   you can specify the -ToScreen switch.
   Info entries will be written in cyan color, Yellow for warnings, and Red for the errors.
 
   PS > Write-Log -Category WAR -Message 'This is a warning to be written in the log file' -ToScreen
 
.NOTES
   AUTHOR: Arnaud PETITJEAN - arnaud@powershell-scripting.com
   VERSION: 1.0.0
   LASTEDIT: 2016/08/25
 
#>

    [cmdletBinding(DefaultParameterSetName="set1", SupportsShouldProcess=$False)]
    PARAM (
        [parameter(Mandatory=$true, ParameterSetName="set1", ValueFromPipeline=$false, position=0)]
        [MsgCategory]$Category,
       
        [parameter(Mandatory=$true, ParameterSetName="set1", ValueFromPipeline=$false, position=1)]
        [Alias("Msg")]
        [String]$Message,
       
        [parameter(Mandatory=$true, ParameterSetName="set2", ValueFromPipeline=$false)]
        [Switch]$Header,
       
        [parameter(Mandatory=$true, ParameterSetName="set3", ValueFromPipeline=$false)]
        [Switch]$Footer,

        [parameter(Mandatory=$true, ParameterSetName="set2", ValueFromPipeline=$false)]
        [String]$LogFile,
       
        [parameter(Mandatory=$false, ValueFromPipeline=$false)]
        [Switch]$ToScreen=$false
    )
   
    $Color = 'Cyan'
        
    Switch ($PsCmdlet.ParameterSetName)
    {
       "set1"
       {
           $date = Get-Date -UFormat "%Y/%m/%d %H:%M:%S"
           switch ($Category)
           {
               INF  { $Message = "$date; INF; $Message"; $Color = 'Cyan'   ; break }
               WAR  { $Message = "$date; WAR; $Message"; $Color = 'Yellow' ; break }
               ERR  { $Message = "$date; ERR; $Message"; $Color = 'Red'    ; break }
           }
            
           Add-Content -Path $Global:LogFile -Value $Message
 
           break
       }
         
       "set2"
       {
          New-Variable -Name LogFile -Value $LogFile -Option ReadOnly -Visibility Public -Scope Global -force
          $currentScriptName = $myinvocation.ScriptName
          $currentUser = $ENV:USERDOMAIN + '\' + $ENV:USERNAME
          $currentComputer = $ENV:COMPUTERNAME
          $StartDate_str = Get-Date -UFormat "%Y/%m/%d %H:%M:%S"
          $WmiInfos = Get-WmiObject win32_operatingsystem
          $OSName  = $WmiInfos.caption
          $OSSP    = $WmiInfos.csdversion
          $OSArchi = $WmiInfos.OSArchitecture
          $Message = @"
+----------------------------------------------------------------------------------------+
 
Nom du script : $currentScriptName
Généré le : $StartDate_str
 
Utilisateur courant : $currentUser
Ordinateur courant : $currentComputer
Système d'exploitation : $OSName $OSSP
OS Architecture : $OSArchi
 
+----------------------------------------------------------------------------------------+
"@

          # Création du fichier de log
          [VOID] (New-Item -ItemType File -Path $LogFile -Force)
          Add-Content -Path $LogFile -Value $Message
          break
       }
                  
       "set3"
       {
          # Analyse de l'entête du fichier de log pour extraire la date de début et conversion de la chaine en type [DateTime]
          [VOID]( (Get-Content $Global:logFile -TotalCount 4)[-1] -match '^Généré le\s*: (?<date>\d{4}/\d{2}/\d{2} \d{2}:\d{2}:\d{2})$' )   # On ignore le résultat boolean car ce qui nous intéresse est stockés dans $Matches
          if ($Matches.date -eq $null)
          {
             throw "Impossible de récupérer la date de début d'exécution. Vérifiez que le fichier de log possède bien une entête de fichier."
          }
          $StartDate = [DateTime]$Matches.date
          $EndDate = Get-Date
          $EndDate_str = Get-Date $EndDate -UFormat "%Y/%m/%d %H:%M:%S"

          $duration_TotalSeconds = [int](New-TimeSpan -Start $StartDate -End $EndDate | Select-Object -ExpandProperty TotalSeconds)
          $duration_TotalMinutes = (New-TimeSpan -Start $StartDate -End $EndDate | Select-Object -ExpandProperty TotalMinutes)
          $duration_TotalMinutes = [MATH]::Round($duration_TotalMinutes, 2)
          $Message = @"
+----------------------------------------------------------------------------------------+
 
Fin: $EndDate_str
Temps écoulé (en secondes): $duration_TotalSeconds
Temps écoulé (en minutes ): $duration_TotalMinutes
 
+----------------------------------------------------------------------------------------+
"@

          # Création du fichier de log
          Add-Content -Path $Global:LogFile -Value $Message
          break
       }
   } # End switch

   if ($ToScreen)
   {
       Write-Host $Message -ForegroundColor $Color
   }
}