Public/Get-CCMLogFile.ps1
|
Function Get-CCMLogFile { <# .SYNOPSIS Parse Configuration Manager format logs .DESCRIPTION This function is used to take Configuration Manager formatted logs and turn them into a PSCustomObject so that it can be searched and manipulated easily with PowerShell .PARAMETER LogFilePath Path to the log file(s) you would like to parse. .PARAMETER ParseSMSTS Only pulls out the TS actions. This is for parsing an SMSTSLog specifically .PARAMETER Filter A custom regex filter to use when reading in log lines .EXAMPLE PS C:\> Get-CCMLogFile -LogFilePath 'c:\windows\ccm\logs\ccmexec.log' Returns the CCMExec.log as a PSCustomObject .EXAMPLE PS C:\> Get-CCMLogFile -LogFilePath 'c:\windows\ccm\logs\AppEnforce.log', 'c:\windows\ccm\logs\AppDiscovery.log' Returns the AppEnforce.log and the AppDiscovery.log as a PSCustomObject .EXAMPLE PS C:\> Get-CCMLogFile -LogFilePath 'c:\windows\ccm\logs\smstslog.log' -ParseSMSTS Returns all the actions that ran according to the SMSTSLog provided .EXAMPLE PS C:\> Get-CCMLogFile -LogFilePath 'c:\windows\ccm\logs\cas.log' -Filter "Successfully created download request \{(\{){0,1}[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}(\}){0,1}\} for content (\{){0,1}[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}(\}){0,1}\.\d+" Return all log entires from the CAS.Log which pertain creating download requests for updates .OUTPUTS [pscustomobject] .NOTES I've done my best to test this against various SCCM log files. They are all generally 'formatted' the same, but do have some variance. I had to also balance speed and parsing. With that said, it can still parse a typical SCCM log VERY quickly. Smaller logs are parsed in milliseconds in my testing. Rolled over logs that are 5mb can be parsed in a couple seconds or less. The -Filter option provides a great deal of flexibility and speed as well. FileName: Get-CCMLogFile.ps1 Author: Cody Mathis Contact: @CodyMathis123 Created: 2019-09-19 Updated: 2020-02-01 #> [CmdletBinding(DefaultParameterSetName = '__AllParameterSets')] param ( [Parameter(Mandatory = $true, ValueFromPipelineByPropertyName)] [Alias('Fullname')] [string[]]$LogFilePath, [Parameter(Mandatory = $false, ParameterSetName = 'ParseSMSTS')] [switch]$ParseSMSTS, [Parameter(Mandatory = $false, ParameterSetName = 'CustomFilter')] [string]$Filter ) begin { try { Add-Type -ErrorAction SilentlyContinue -TypeDefinition @" public enum Severity { None, Informational, Warning, Error } "@ } catch { Write-Debug "Type Severity already exists" } function Get-TimeStampFromLogLine { <# .SYNOPSIS Parses a datetime object from an MEMCM log line .DESCRIPTION This will return a datetime object if it is passed the part of an MEMCM log line that contains the date and time .PARAMETER DateString The Date String component from a MEMCM log line. For example, '01-31-2020' .PARAMETER TimeString The Time String component from a MEMCM log line. For example, '14:20:41.461' .EXAMPLE PS C:\> Get-TimeStampFromLogLine -LogLineSubArray $LogLineSubArray return datetime object from the log line that was split into a subarray #> param ( [Parameter(Mandatory = $true)] [string]$DateString, [Parameter(Mandatory = $true)] [string]$TimeString ) $DateStringArray = $DateString.Split("-") $MonthParser = $DateStringArray[0] -replace '\d', 'M' $DayParser = $DateStringArray[1] -replace '\d', 'd' $DateTimeFormat = [string]::Format('{0}-{1}-yyyyHH:mm:ss.fff', $MonthParser, $DayParser) $DateTimeString = [string]::Format('{0}{1}', $DateString, $TimeString) [datetime]::ParseExact($DateTimeString, $DateTimeFormat, $null) } } process { Foreach ($LogFile in $LogFilePath) { #region ingest log file with StreamReader. Quick, and prevents locks $File = [System.IO.File]::Open($LogFile, 'Open', 'Read', 'ReadWrite') $StreamReader = New-Object System.IO.StreamReader($File) [string]$LogFileRaw = $StreamReader.ReadToEnd() $StreamReader.Close() $File.Close() #endregion ingest log file with StreamReader. Quick, and prevents locks #region perform a regex match to determine the 'type' of log we are working with and parse appropriately switch ($true) { #region parse a 'typical' SCCM log (([Regex]::Match($LogFileRaw, "LOG\[(.*?)\]LOG(.*?)time(.*?)date")).Success) { # split on what we know is a line beginning switch -regex ($LogFileRaw -split "<!\[LOG\[") { '^\s*$' { # ignore empty lines continue } default { <# split Log line into an array on what we know is the end of the message section first item contains the message which can be parsed second item contains all the information about the message/line (ie. type, component, datetime, thread) which can be parsed #> $LogLineArray = $PSItem -split "]LOG]!><" # Strip the log message out of our first array index $Message = $LogLineArray[0] # Split LogLineArray into a a sub array based on double quotes to pull log line information $LogLineSubArray = $LogLineArray[1].Split('"') $LogLine = [System.Collections.Specialized.OrderedDictionary]::new() # Rebuild the LogLine into a hash table $LogLine['Message'] = $Message $LogLine['Type'] = [Severity]$LogLineSubArray[9] $LogLine['Component'] = $LogLineSubArray[5] $LogLine['Thread'] = $LogLineSubArray[11] $DateString = $LogLineSubArray[3] $TimeString = ($LogLineSubArray[1]).Split("+|-")[0].ToString().Substring(0, 12) # if we are Parsing SMSTS then we will only pull out messages that match 'win32 code 0|failed to run the action' switch ($ParseSMSTS.IsPresent) { $true { switch -regex ($Message) { 'win32 code 0|failed to run the action' { $LogLine.TimeStamp = Get-TimeStampFromLogLine -DateString $DateString -TimeString $TimeString [pscustomobject]$LogLine } default { continue } } } $false { switch ($PSCmdlet.ParameterSetName) { 'CustomFilter' { switch -regex ($Message) { $Filter { $LogLine.TimeStamp = Get-TimeStampFromLogLine -DateString $DateString -TimeString $TimeString [pscustomobject]$LogLine } default { continue } } } default { $LogLine['TimeStamp'] = Get-TimeStampFromLogLine -DateString $DateString -TimeString $TimeString [pscustomobject]$LogLine } } } } } } } #endregion parse a 'typical' SCCM log #region parse a 'simple' SCCM log, usually found on site systems (([Regex]::Match($LogFileRaw, '\$\$\<(.*?)\>\<thread=')).Success) { switch -regex ($LogFileRaw -split [System.Environment]::NewLine) { '^\s*$' { # ignore empty lines continue } default { <# split Log line into an array first item contains the message which can be parsed second item contains all the information about the message/line (ie. type, component, timestamp, thread) which can be parsed #> $LogLineArray = $PSItem -split '\$\$<' # Strip the log message out of our first array index $Message = $LogLineArray[0] # Split LogLineArray into a a sub array based on double quotes to pull log line information $LogLineSubArray = $LogLineArray[1].Split("><", [System.StringSplitOptions]::RemoveEmptyEntries) switch -regex ($Message) { '^\s*$' { # ignore empty messages continue } default { $LogLine = [System.Collections.Specialized.OrderedDictionary]::new() # Rebuild the LogLine into a hash table $LogLine['Message'] = $Message $LogLine['Type'] = [Severity]0 $LogLine['Component'] = $LogLineSubArray[0].Trim() $LogLine['Thread'] = ($LogLineSubArray[2].Split(" ", [System.StringSplitOptions]::RemoveEmptyEntries))[0].Substring(7) $DateTimeString = $LogLineSubArray[1] $DateTimeStringArray = $DateTimeString.Split(" ", [System.StringSplitOptions]::RemoveEmptyEntries) $DateString = $DateTimeStringArray[0].ToString() $TimeString = $DateTimeStringArray[1].ToString().Split("+|-", [System.StringSplitOptions]::RemoveEmptyEntries)[0].ToString().Substring(0, 12) switch ($PSCmdlet.ParameterSetName) { 'CustomFilter' { switch -regex ($Message) { $Filter { $LogLine.TimeStamp = Get-TimeStampFromLogLine -DateString $DateString -TimeString $TimeString [pscustomobject]$LogLine } default { continue } } } default { $LogLine['TimeStamp'] = Get-TimeStampFromLogLine -DateString $DateString -TimeString $TimeString [pscustomobject]$LogLine } } } } } } } #endregion parse a 'simple' SCCM log, usually found on site systems } #endregion perform a regex match to determine the 'type' of log we are working with and parse appropriately } } } |