functions/Read-DbaXEventFile.ps1
|
function Read-DbaXEventFile { <# .SYNOPSIS Read XEvents from a xel or xem file .DESCRIPTION Read XEvents from a xel or xem file. Returns a weird Microsoft.SqlServer.XEvent.Linq.QueryableXEventData enumeration object. .PARAMETER Path The path to the file. This is relative to the computer executing the command. UNC paths supported. .PARAMETER Exact By default, this command will add a wildcard to the Path because Eventing uses the file name as a template and adds characters. Use this to skip the addition of the wildcard. .PARAMETER Silent If this switch is enabled, the internal messaging functions will be silenced. .NOTES Tags: Xevent Website: https://dbatools.io Copyright: (C) Chrissy LeMaire, clemaire@gmail.com License: GNU GPL v3 https://opensource.org/licenses/GPL-3.0 .LINK https://dbatools.io/Read-DbaXEventFile .EXAMPLE Read-DbaXEventFile -SqlInstance ServerA\sql987 -Path C:\temp\deadocks.xel Returns events .EXAMPLE Get-DbaXEventSession -SqlInstance sql2014 -Session deadlocks | Read-DbaXEventFile Reads remote xevents by acccessing the file over the admin UNC share #> [CmdletBinding()] param ( [parameter(Mandatory, ValueFromPipeline)] [object[]]$Path, [switch]$Exact, [switch]$Silent ) process { foreach ($file in $path) { if ($file -is [System.String]) { $currentfile = $file } else { if ($file.TargetFile.Length -eq 0) { continue } $instance = [dbainstance]$file.ComputerName if ($instance.IsLocalHost) { $currentfile = $file.TargetFile } else { $currentfile = $file.RemoteTargetFile } } if (-not $Exact) { $currentfile = $currentfile.Replace('.xel', '*.xel') $currentfile = $currentfile.Replace('.xem', '*.xem') } $accessible = Test-Path -Path $currentfile $whoami = whoami if (-not $accessible) { if ($file.Status -eq "Stopped") { continue } Stop-Function -Continue -Message "$currentfile cannot be accessed from $($env:COMPUTERNAME). Does $whoami have access?" } New-Object Microsoft.SqlServer.XEvent.Linq.QueryableXEventData($currentfile) } } } |