PowerShell.com
Library » Script Library » Logs » Script Template with logging function

Script Template with logging function

Previous | Next | View all files | View Slideshow
posted by Axel Kara
11-26-2009
Downloads: 754
File size: 4.4kB
Views: 3,785
Embed
Script Template with logging function
  1. #******************************************************************* 
  2. # Global Variables 
  3. #******************************************************************* 
  4. $Script:Version      = '1.0.9.1126' 
  5. $Script:LogSeparator = '*******************************************************************************' 
  6. $Script:LogFile      = "" 
  7.  
  8. #******************************************************************* 
  9. # Functions 
  10. #******************************************************************* 
  11. function Get-ScriptName(){ 
  12. # 
  13. #      .SYNOPSIS 
  14. #          Extracts the script name 
  15. #      .DESCRIPTION 
  16. #          Extracts the script file name without extention 
  17. #      .NOTES 
  18. #         Author:    Axel Kara, axel.kara@gmx.de 
  19. # 
  20.     $tmp = $MyInvocation.ScriptName.Substring($MyInvocation.ScriptName.LastIndexOf('\') + 1) 
  21.     $tmp.Substring(0,$tmp.Length - 4) 
  22. } 
  23.  
  24. function Write-Log($Msg, [System.Boolean]$LogTime=$true){ 
  25. # 
  26. #      .SYNOPSIS 
  27. #          Creates a log entry 
  28. #      .DESCRIPTION 
  29. #          By default a time stamp will be logged too. This can be 
  30. #        disabled with the -LogTime $false parameter 
  31. #      .NOTES 
  32. #         Author:    Axel Kara, axel.kara@gmx.de 
  33. #      .EXAMPLE 
  34. #          Write-Log -Msg 'Log entry created successfull.' [-LogTime $false] 
  35. # 
  36.     if($LogTime){ 
  37.         $date = Get-Date -format dd.MM.yyyy 
  38.         $time = Get-Date -format HH:mm:ss 
  39.        Add-Content -Path $LogFile -Value ($date + " " + $time + "   " + $Msg) 
  40.     } 
  41.     else{ 
  42.         Add-Content -Path $LogFile -Value $Msg 
  43.     } 
  44. } 
  45.  
  46. function Initialize-LogFile($File, [System.Boolean]$reset=$false){ 
  47. # 
  48. #      .SYNOPSIS 
  49. #          Initializes the log file 
  50. #      .DESCRIPTION 
  51. #         Creates the log file header 
  52. #          Creates the folder structure on local drives if necessary 
  53. #        Resets existing log if used with -reset $true 
  54. #      .NOTES 
  55. #         Author:    Axel Kara, axel.kara@gmx.de 
  56. #      .EXAMPLE 
  57. #          Initialize-LogFile -File 'C:\Logging\events.log' [-reset $true] 
  58. # 
  59. try{ 
  60.         #Check if file exists 
  61.         if(Test-Path -Path $File){ 
  62.             #Check if file should be reset 
  63.             if($reset){ 
  64.                 Clear-Content $File -ErrorAction SilentlyContinue 
  65.             } 
  66.         } 
  67.         else{ 
  68.             #Check if file is a local file 
  69.             if($File.Substring(1,1) -eq ':'){ 
  70.                 #Check if drive exists 
  71.                 $driveInfo = [System.IO.DriveInfo]($File) 
  72.                 if($driveInfo.IsReady -eq $false){ 
  73.                     Write-Log -Msg ($driveInfo.Name + " not ready.") 
  74.                 } 
  75.                  
  76.                 #Create folder structure if necessary 
  77.                 $Dir = [System.IO.Path]::GetDirectoryName($File) 
  78.                 if(([System.IO.Directory]::Exists($Dir)) -eq $false){ 
  79.                     $objDir = [System.IO.Directory]::CreateDirectory($Dir) 
  80.                     Write-Log -Msg ($Dir + " created.") 
  81.                 } 
  82.             } 
  83.         } 
  84.         #Write header 
  85.         Write-Log -LogTime $false -Msg $LogSeparator 
  86.         Write-Log -LogTime $false -Msg (((Get-ScriptName).PadRight($LogSeparator.Length - ("   Version " + $Version).Length," ")) + "   Version " + $Version) 
  87.         Write-Log -LogTime $false -Msg $LogSeparator 
  88.     } 
  89.     catch{ 
  90.         Write-Log -Msg $_ 
  91.     } 
  92. } 
  93.  
  94. function Read-Arguments($Values = $args) { 
  95. # 
  96. #      .SYNOPSIS 
  97. #          Reads named script arguments 
  98. #      .DESCRIPTION 
  99. #          Reads named script arguments separated by '=' and tagged with'-' character 
  100. #      .NOTES 
  101. #         Author:    Axel Kara, axel.kara@gmx.de 
  102. # 
  103.     foreach($value in $Values){ 
  104.          
  105.         #Change the character that separates the arguments here 
  106.         $arrTmp = $value.Split("=") 
  107.          
  108.         switch ($arrTmp[0].ToLower()) { 
  109.             -log { 
  110.                 $Script:LogFile = $arrTmp[1] 
  111.             } 
  112.         } 
  113.     } 
  114. } 
  115.  
  116. #******************************************************************* 
  117. # Main Script 
  118. #******************************************************************* 
  119. if($args.Count -ne 0){ 
  120.     #Read script arguments 
  121.     Read-Arguments 
  122.     if($LogFile.StartsWith("\\")){ 
  123.         Write-Host "UNC" 
  124.     } 
  125.     elseif($LogFile.Substring(1,1) -eq ":"){ 
  126.         Write-Host "Local" 
  127.     } 
  128.     else{ 
  129.         $LogFile = [System.IO.Path]::Combine((Get-Location), $LogFile) 
  130.     } 
  131.      
  132.     if($LogFile.EndsWith(".log") -eq $false){ 
  133.         $LogFile += ".log" 
  134.     } 
  135. } 
  136.  
  137. if($LogFile -eq ""){ 
  138.     #Set log file 
  139.     $LogFile = [System.IO.Path]::Combine((Get-Location), (Get-ScriptName) + ".log") 
  140. } 
  141.  
  142. #Write log header 
  143. Initialize-LogFile -File $LogFile -reset $false 
  144.  
  145.  
  146.  
  147. #/////////////////////////////////// 
  148. #/// Enter your script code here /// 
  149. #/////////////////////////////////// 
  150.  
  151.  
  152. #Write log footer 
  153. Write-Log -LogTime $false -Msg $LogSeparator 
  154. Write-Log -LogTime $false -Msg '' 

This template contains a text based logging function.

By default the log file is placed beside the calling script, but you can also specify a log file with the -log script parameter.

Concentrated Tech NSoftware Dell Compellent Sponsored by Idera and Concentrated Tech and NSoftware and Dell Compellent
Copyright 2011 PowerShell.com. All rights reserved.