< Back

Read-DbaXEFile

Mon Jan 13, 2020 1:07 pm

NAME Read-DbaXEFile



SYNOPSIS

Read XEvents from a *.xel or *.xem file.





SYNTAX

Read-DbaXEFile [-Path] <System.Object[]> [-Exact <Switch>] [-Raw <Switch>] [-EnableException <Switch>]

[<CommonParameters>]





DESCRIPTION

Read XEvents from a *.xel or *.xem file.





PARAMETERS

-EnableException [<Switch>]

By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.

This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables

advanced scripting.

Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own

try/catch.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Exact [<Switch>]

If this switch is enabled, only an exact search will be used for the Path. By default, this command will add a

wildcard to the Path because Eventing uses the file name as a template and adds characters.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Path [<System.Object[]>]

The path to the *.xem or *.xem file. This is relative to the computer executing the command. UNC paths are

supported.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



-Raw [<Switch>]

If this switch is enabled, the Microsoft.SqlServer.XEvent.Linq.PublishedEvent enumeration object will be

returned.



Required? false

Position? named

Default value

Accept pipeline input? False

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



NOTES





Tags: ExtendedEvent, XE, XEvent

Author: Chrissy LeMaire (@cl), netnerds.net



Website: https://dbatools.io

Copyright: (c) 2018 by dbatools, licensed under MIT

License: MIT https://opensource.org/licenses/MIT



-------------------------- EXAMPLE 1 --------------------------



PS C:\\>Read-DbaXEFile -Path C:\\temp\\deadocks.xel



Returns events from C:\\temp\\deadocks.xel.

-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-ChildItem C:\\temp\\xe\\*.xel | Read-DbaXEFile



Returns events from all .xel files in C:\\temp\\xe.

-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-DbaXESession -SqlInstance sql2014 -Session deadlocks | Read-DbaXEFile



Reads remote XEvents by accessing the file over the admin UNC share.



RELATED LINKS

https://dbatools.io/Read-DbaXEFile