functions/Get-DbaXESessionTemplate.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
function Get-DbaXESessionTemplate {
 <#
    .SYNOPSIS
    Parses Extended Event XML templates. Defaults to parsing templates in our template repository (\bin\xetemplates\)
 
    .DESCRIPTION
    Parses Extended Event XML templates. Defaults to parsing templates in our template repository (\bin\xetemplates\)
     
    The default repository contains templates from:
     
            Microsoft's Templates that come with SSMS
            Jes Borland's "Everyday Extended Events" presentation and GitHub repository (https://github.com/grrlgeek/extended-events)
            Christian Gräfe's XE Repo: https://github.com/chrgraefe/sqlscripts/blob/master/XE-Events/
            Erin Stellato's Blog: https://www.sqlskills.com/blogs/erin/
     
    Some profile templates converted using:
     
            sp_SQLskills_ConvertTraceToExtendedEvents.sql
            Jonathan M. Kehayias, SQLskills.com
            http://sqlskills.com/blogs/jonathan
 
    .PARAMETER Path
    The path to the template directory. Defaults to our template repository (\bin\xetemplates\)
     
    .PARAMETER Pattern
    Specify a pattern for filtering. Alternatively, you can use Out-GridView -Passthru to select objects and pipe them to Import-DbaXESessionTemplate
 
    .PARAMETER EnableException
    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.
 
    .NOTES
    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/Get-DbaXESessionTemplate
 
    .EXAMPLE
    Get-DbaXESessionTemplate
 
    Returns information about all the templates in the local dbatools repository
 
    .EXAMPLE
    Get-DbaXESessionTemplate | Out-GridView -PassThru | Import-DbaXESessionTemplate -SqlInstance sql2017 | Start-DbaXESession
 
    Allows you to select a Session template then import to an instance named
 
    .EXAMPLE
    Get-DbaXESessionTemplate -Path "$home\Documents\SQL Server Management Studio\Templates\XEventTemplates"
 
    Returns information about all the templates in your local XEventTemplates repository
     
    .EXAMPLE
    Get-DbaXESessionTemplate -Pattern duration
 
    Returns information about all the templates that match the word duration in the title, category or body
     
    .EXAMPLE
    Get-DbaXESessionTemplate | Select *
 
    Returns more information about the template, including the full path/filename
 
#>

    [CmdletBinding()]
    param (
        [string[]]$Path = "$script:PSModuleRoot\bin\xetemplates",
        [string]$Pattern,
        [switch]$EnableException
    )
    begin {
        $metadata = Import-Clixml "$script:PSModuleRoot\bin\xetemplates-metadata.xml"
    }
    process {
        foreach ($directory in $Path) {
            $files = Get-ChildItem "$directory\*.xml"
            foreach ($file in $files) {
                try {
                    $xml = [xml](Get-Content $file)
                }
                catch {
                    Stop-Function -Message "Failure" -ErrorRecord $_ -Target $file -Continue
                }
                
                foreach ($session in $xml.event_sessions) {
                    $meta = $metadata | Where-Object Name -eq $session.event_session.name
                    if ($Pattern) {
                        if (
                            # There's probably a better way to do this
                            ($session.event_session.name -match $Pattern) -or
                            ($session.event_session.TemplateCategory.'#text' -match $Pattern) -or
                            ($session.event_session.TemplateSource -match $Pattern) -or
                            ($session.event_session.TemplateDescription.'#text' -match $Pattern) -or
                            ($session.event_session.TemplateName.'#text' -match $Pattern) -or
                            ($meta.Source -match $Pattern)
                        ) {
                            [pscustomobject]@{
                                Name             = $session.event_session.name
                                Category         = $session.event_session.TemplateCategory.'#text'
                                Source           = $meta.Source
                                Compatability    = $meta.Compatability.ToString().Replace(",", "")
                                Description      = $session.event_session.TemplateDescription.'#text'
                                TemplateName     = $session.event_session.TemplateName.'#text'
                                Path             = $file
                                File             = $file.Name
                            } | Select-DefaultView -ExcludeProperty File, TemplateName, Path
                        }
                    }
                    else {
                        [pscustomobject]@{
                            Name             = $session.event_session.name
                            Category         = $session.event_session.TemplateCategory.'#text'
                            Source           = $meta.Source
                            Compatability    = $meta.Compatability.ToString().Replace(",", "")
                            Description      = $session.event_session.TemplateDescription.'#text'
                            TemplateName     = $session.event_session.TemplateName.'#text'
                            Path             = $file
                            File             = $file.Name
                        } | Select-DefaultView -ExcludeProperty File, TemplateName, Path
                    }
                }
            }
        }
    }
}