PowerShell.com
Library » Script Library » Logs » Slideshow

Logs Slideshow

  1. <# 
  2.     .SYNOPSIS 
  3.         Get-BCLog retrieves a log file which is a collection of BCLogEntries 
  4.         which have been stored in an XML file. 
  5.     .DESCRIPTION 
  6.         There are a collection of cmdlets for supporting log functionality.   
  7.         The basis of the system is a custom PowerShell object which contains 
  8.         five parameters:  
  9.             TimeStamp 
  10.             Sources 
  11.             Category 
  12.             Message 
  13.             Level 
  14.         The entries are returned latest first. 
  15.     .PARAMETER  logFileName 
  16.         The full name of the xml file that stores the xml structure. 
  17.     .EXAMPLE 
  18.         Get-BCLog c:\data\logfile.xml 
  19. #> 
  20. function Get-BCLog 
  21. { 
  22. PARAM 
  23. ( 
  24.     [parameter(Mandatory=$true)] 
  25.     [String]$logFileName 
  26. ) 
  27.     if (Test-Path -Path $logFileName) 
  28.     { 
  29.         $tempLog = @(Import-Clixml $logFileName) 
  30.     } 
  31.     else 
  32.     { 
  33.         $tempLog = $null 
  34.     } 
  35.     return $tempLog 
  36. } 
  37. <# 
  38.     .SYNOPSIS 
  39.         Get-BCLogEntry retrieves a collection of BCLogEntry objects from a 
  40.         log file that meet specified criteria. 
  41.     .DESCRIPTION 
  42.         Get-BCLogEntry retrieves log entries from a log file.  Command line 
  43.         parameters define how many entries to retrieve and the entries to 
  44.         retrieve based on the the parameters specified. With the exception 
  45.         of the level and minimum level parameters, all the parameters are 
  46.         'anded' together.  The level and minimumLevel parameters are also 
  47.         'anded', the level parameter takes precedence over the  
  48.         minimumLevel parameter.  
  49.     .PARAMETER  logFileName 
  50.         This parameter contains the path to the file that stores the log. 
  51.     .PARAMETER count 
  52.         The maximum number of log entries to retrieve.  The default retrieves 
  53.         all entries.   
  54.     .PARAMETER level 
  55.         The level number of log entries to retrieve.  The default will  
  56.         retrieve all entries. 
  57.         This parameter takes precedence over the minimumLevel parameter. 
  58.     .PARAMETER minimumLevel 
  59.         Log entries with a level setting greater than or equal to this number 
  60.         will be retrieved. 
  61.         The default will retrieve all entries. This parameter will be 
  62.         overridden by the level parameter. 
  63.     .PARAMETER taskCategory 
  64.         Restrict the entries retrieved to those from a specific category.  This 
  65.         parameter accepts wildcards. 
  66.     .PARAMETER source 
  67.         Restrict the entries retrieved to those from a specific source.  This 
  68.         parameter accepts wildcards. 
  69.     .PARAMETER startTimeStamp 
  70.         This parameter restricts the entries returned to those with a 
  71.         timeStamp greater than or equal to the value specified. 
  72.     .PARAMETER endTimeStamp 
  73.         This parameter restricts the entries returned to those with a 
  74.         timeStamp less than or equal to the value specified. 
  75.     .EXAMPLE 
  76.         Get-BCLogEntry c:\data\mylog.xml 
  77.     .EXAMPLE 
  78.         Get-BCLogEntry c:\data\mylog.xml -count 1 
  79.     .EXAMPLE 
  80.         Get-BCLogEntry c:\data\mylog.xml -count 1 -source inst* 
  81.     .EXAMPLE 
  82.         Get-BCLogEntry c:\data\mylog.xml -source Inst* -taskCategory Archive -minimumLevel 2 
  83.     .EXAMPLE 
  84.         Get-BCLogEntry c:\data\mylog.xml -count 10 -startTimeStamp (get-Date -hour 13 -minute 5) -endTimeStamp (Get-Date -hour 13 -minute 12) 
  85. #> 
  86. function Get-BCLogEntry 
  87. { 
  88. PARAM 
  89. ( 
  90.     [parameter(Mandatory=$true)] 
  91.     [string]$logFileName, 
  92.     [parameter()] 
  93.     [int]$count = 0, 
  94.     [parameter()] 
  95.     [int]$level = -1, 
  96.     [parameter()] 
  97.     [int]$minimumLevel = 0, 
  98.     [parameter()] 
  99.     [string]$taskCategory = "*", 
  100.     [parameter()] 
  101.     [string]$source = "*", 
  102.     [parameter()] 
  103.     [DateTime]$startTimeStamp, 
  104.     [parameter()] 
  105.     [DateTime]$endTimeStamp 
  106. ) 
  107.     $log = Get-BCLog $logFilename 
  108.     if ($log -ne $null) 
  109.     { 
  110.         $selectedEntries = @() 
  111.         if ($startTimeStamp -eq $null) 
  112.         { 
  113.             $startTimeStamp = (Get-Date -Year 1900) 
  114.         } 
  115.         if ($endTimeStamp -eq $null) 
  116.         { 
  117.             $endTimeStamp = (Get-Date) 
  118.         } 
  119.         if ($log -eq $null) 
  120.         { 
  121.             Write-Warning "Log file $logFileName was not found" 
  122.         } 
  123.         else 
  124.         { 
  125.             foreach ($logEntry in $log) 
  126.             { 
  127.                 if ($logEntry -ne $null) 
  128.                 { 
  129.                     if ($logEntry.source -like $source -and  
  130.                         $logEntry.TaskCategory -like $taskCategory -and  
  131.                         $logEntry.TimeStamp -ge $startTimeStamp -and $logEntry.TimeStamp -le $endTimeStamp -and 
  132.                         ($logEntry.Level -eq $level -or $level -lt 0) -and $logEntry.Level -ge $minimumLevel) 
  133.                     { 
  134.                         $selectedEntries += $logEntry 
  135.                         if ($selectedEntries.Count -ge $count -and $count -gt 0) 
  136.                         { 
  137.                             break; 
  138.                         } 
  139.                     }  
  140.                 }  
  141.             } 
  142.             Write-Output $selectedEntries 
  143.         } 
  144.     } 
  145.     else 
  146.     { 
  147.         throw "$logFileName was not found." 
  148.     }      
  149. } 
  150. <# 
  151.     .SYNOPSIS 
  152.         Add-BCLogEntry creates and adds a log entry object to the identified log 
  153.         file. 
  154.     .DESCRIPTION 
  155.         Add-BCLogEntry needs the name of the logfile and details of the log entry. 
  156.         It creates a log object and adds it to the file.  The entry will have a 
  157.         DateTime stamp added to the entry. 
  158.     .PARAMETER  logFile 
  159.         The utility requires the name of the log file to be used.  It uses the Get-BCLog 
  160.         utility to retrieve or create the log file. 
  161.     .PARAMETER  level 
  162.         The level parameter is used to identify the level of the message.  The acceptable range for 
  163.         this parameter is 0-4.  The Get-BCLogLevelMessage cmdlet can convert the number to a text message. 
  164.         The intention of the level is to indicate the severity of the message: 
  165.             0 Information 
  166.             1 Warning 
  167.             2 Error 
  168.             3 Critical 
  169.             4 Fatal 
  170.     .PARAMETER  source 
  171.         The source parameter is used to identify the application that is making the log 
  172.         entry. 
  173.     .PARAMETER  category 
  174.         The category parameter is used to provide a categorisation for the log entry. 
  175.     .PARAMETER  message 
  176.         The message to be recorded. 
  177.     .EXAMPLE 
  178.         Add-BCLogEntry c:\data\MyLog.xml 1 InstCal SendEmail "Email sent to fbloggs"  
  179. #> 
  180. function Add-BCLogEntry 
  181. { 
  182. PARAM 
  183. ( 
  184.     [parameter(Mandatory=$true)] 
  185.     [String]$logFile, 
  186.     [parameter(Mandatory=$true)] 
  187.     [int]$level, 
  188.     [parameter(Mandatory=$true)] 
  189.     [String]$source, 
  190.     [parameter(Mandatory=$true)] 
  191.     [String]$taskCategory, 
  192.     [parameter(Mandatory=$true)] 
  193.     [String]$message 
  194. ) 
  195.     $LogEntry = New-Object PSObject -Property @{             
  196.         TimeStamp = ""  
  197.         Level = 0                 
  198.         Source = "" 
  199.         TaskCategory = "" 
  200.         Message = ""                    
  201.     }    
  202.      
  203.     $LogEntry.TimeStamp = Get-Date 
  204.     $LogEntry.Level = $level 
  205.     $LogEntry.Source = $source 
  206.     $LogEntry.TaskCategory = $taskCategory 
  207.     $LogEntry.Message = $message 
  208.      
  209.     $log = @($LogEntry) 
  210.     if (Test-Path -Path $logFile) 
  211.     { 
  212.         $log += Get-BCLog $logFile 
  213.     } 
  214.     $log | Export-Clixml -path $logFile -Depth 5 -Force 
  215. } 
  216.  
  217. function Get-BCLogLevelMessage 
  218. { 
  219. Param 
  220. ( 
  221.     [parameter(Mandatory=$true)] 
  222.     [ValidateRange(0,4)] 
  223.     [int]$logLevel 
  224. ) 
  225.  
  226.     $levels = @(“Information”, “Warning”, “Error”,"Critical","Fatal") 
  227.     return $levels[$logLevel] 
  228. } 
  229.  
  230. function Get-BCLogLevelFromMessage 
  231. { 
  232. Param 
  233. ( 
  234.     [parameter(Mandatory=$true)] 
  235.     [string]$logLevelMessage 
  236. ) 
  237.  
  238.     $levels = @(“Information”, “Warning”, “Error”,"Critical","Fatal") 
  239.     $index = -1 
  240.     for ($i = 0;$i -lt $levels.Count;$i++) 
  241.     { 
  242.         if ($levels[$i] -eq $logLevelMessage) 
  243.         { 
  244.             $index = $i 
  245.         } 
  246.     } 
  247.      
  248.     if ($index -ge 0) 
  249.     { 
  250.         return $index 
  251.     } 
  252.     else 
  253.     { 
  254.         throw "$logLevelMessage is not a valid message." 
  255.     } 
  256. } 
 
Loading...
View all files
Concentrated Tech NSoftware Dell Compellent Sponsored by Idera and Concentrated Tech and NSoftware and Dell Compellent
Copyright 2011 PowerShell.com. All rights reserved.