functions/Find-DbaDatabaseGrowthEvent.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
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
#ValidationTags#Messaging,FlowControl,Pipeline,CodeStyle#
function Find-DbaDatabaseGrowthEvent {
    <#
  .SYNOPSIS
   Finds any database AutoGrow events in the Default Trace.
 
  .DESCRIPTION
   Finds any database AutoGrow events in the Default Trace.
 
   The following events are included:
    92 - Data File Auto Grow
    93 - Log File Auto Grow
    94 - Data File Auto Shrink
    95 - Log File Auto Shrink
 
  .PARAMETER SqlInstance
   SQL Server name or SMO object representing the SQL Server to connect to. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.
 
  .PARAMETER SqlCredential
   Allows you to login to servers using SQL Logins instead of Windows Authentication (AKA Integrated or Trusted). To use:
 
   $scred = Get-Credential, then pass $scred object to the -SqlCredential parameter.
 
   Windows Authentication will be used if SqlCredential is not specified. SQL Server does not accept Windows credentials being passed as credentials.
 
   To connect as a different Windows user, run PowerShell as that user.
 
  .PARAMETER Database
   The database(s) to process - this list is auto-populated from the server. If unspecified, all databases will be processed.
 
  .PARAMETER ExcludeDatabase
   The database(s) to exclude - this list is auto-populated from the server
 
  .PARAMETER EventType
   Provide a filter on growth event type to filter the results.
 
   Allowed values: Growth, Shrink
 
  .PARAMETER FileType
   Provide a filter on file type to filter the results.
 
   Allowed vaules: Data, Log
 
  .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
   Tags: AutoGrow,Growth,Database
   Author: Aaron Nelson
   Query Extracted from SQL Server Management Studio (SSMS) 2016.
 
   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/Find-DbaDatabaseGrowthEvent
 
  .EXAMPLE
   Find-DbaDatabaseGrowthEvent -SqlInstance localhost
 
   Returns any database AutoGrow events in the Default Trace for every database on the localhost instance.
 
  .EXAMPLE
   Find-DbaDatabaseGrowthEvent -SqlInstance ServerA\SQL2016, ServerA\SQL2014
 
   Returns any database AutoGrow events in the Default Traces for every database on ServerA\sql2016 & ServerA\SQL2014.
 
  .EXAMPLE
   Find-DbaDatabaseGrowthEvent -SqlInstance ServerA\SQL2016 | Format-Table -AutoSize -Wrap
 
   Returns any database AutoGrow events in the Default Trace for every database on the ServerA\SQL2016 instance in a table format.
 
  .EXAMPLE
   Find-DbaDatabaseGrowthEvent -SqlInstance ServerA\SQL2016 -EventType Shrink
 
   Returns any database Auto Shrink events in the Default Trace for every database on the ServerA\SQL2016 instance.
 
  .EXAMPLE
   Find-DbaDatabaseGrowthEvent -SqlInstance ServerA\SQL2016 -EventType Growth -FileType Data
 
   Returns any database Auto Growth events on data files in the Default Trace for every database on the ServerA\SQL2016 instance.
 #>

    [CmdletBinding()]
    param (
        [parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [Alias("ServerInstance", "SqlServer")]
        [DbaInstance[]]$SqlInstance,
        [PSCredential]$SqlCredential,
        [Alias("Databases")]
        [object[]]$Database,
        [object[]]$ExcludeDatabase,
        [ValidateSet('Growth', 'Shrink')]
        [string]$EventType,
        [ValidateSet('Data', 'Log')]
        [string]$FileType,
        [switch][Alias('Silent')]$EnableException
    )

    begin {
        $eventClass = New-Object System.Collections.ArrayList
        92..95 | ForEach-Object { $null = $eventClass.Add($_) }

        if (Test-Bound 'EventType', 'FileType') {
            switch ($FileType) {
                'Data' {
                    <# should only contain events for data: 92 (grow), 94 (shrink) #>
                    $eventClass.Remove(93)
                    $eventClass.Remove(95)
                }
                'Log' {
                    <# should only contain events for log: 93 (grow), 95 (shrink) #>
                    $eventClass.Remove(92)
                    $eventClass.Remove(94)
                }
            }
            switch ($EventType) {
                'Growth' {
                    <# should only contain events for growth: 92 (data), 93 (log) #>
                    $eventClass.Remove(94)
                    $eventClass.Remove(95)
                }
                'Shrink' {
                    <# should only contain events for shrink: 94 (data), 95 (log) #>
                    $eventClass.Remove(92)
                    $eventClass.Remove(93)
                }
            }
        }

        $eventClassFilter = $eventClass -join ","

        $sql = "
   BEGIN TRY
    IF (SELECT CONVERT(INT,[value_in_use]) FROM sys.configurations WHERE [name] = 'default trace enabled' ) = 1
     BEGIN
      DECLARE @curr_tracefilename VARCHAR(500);
      DECLARE @base_tracefilename VARCHAR(500);
      DECLARE @indx INT;
 
      SELECT @curr_tracefilename = [path]
      FROM sys.traces
      WHERE is_default = 1 ;
 
      SET @curr_tracefilename = REVERSE(@curr_tracefilename);
      SELECT @indx = PATINDEX('%\%', @curr_tracefilename);
      SET @curr_tracefilename = REVERSE(@curr_tracefilename);
      SET @base_tracefilename = LEFT( @curr_tracefilename,LEN(@curr_tracefilename) - @indx) + '\log.trc';
 
      SELECT
       SERVERPROPERTY('MachineName') AS ComputerName,
       ISNULL(SERVERPROPERTY('InstanceName'), 'MSSQLSERVER') AS InstanceName,
       SERVERPROPERTY('ServerName') AS SqlInstance,
       CONVERT(INT,(DENSE_RANK() OVER (ORDER BY [StartTime] DESC))%2) AS OrderRank,
        CONVERT(INT, [EventClass]) AS EventClass,
       [DatabaseName],
       [Filename],
       CONVERT(INT,(Duration/1000)) AS Duration,
       DATEADD (MINUTE, DATEDIFF(MINUTE, GETDATE(), GETUTCDATE()), [StartTime]) AS StartTime, -- Convert to UTC time
       DATEADD (MINUTE, DATEDIFF(MINUTE, GETDATE(), GETUTCDATE()), [EndTime]) AS EndTime, -- Convert to UTC time
       ([IntegerData]*8.0/1024) AS ChangeInSize
      FROM::fn_trace_gettable( @base_tracefilename, DEFAULT )
      WHERE
       [EventClass] IN ($eventClassFilter)
       AND [ServerName] = @@SERVERNAME
       AND [DatabaseName] IN (_DatabaseList_)
      ORDER BY [StartTime] DESC;
     END
    ELSE
     SELECT
      SERVERPROPERTY('MachineName') AS ComputerName,
      ISNULL(SERVERPROPERTY('InstanceName'), 'MSSQLSERVER') AS InstanceName,
      SERVERPROPERTY('ServerName') AS SqlInstance,
      -100 AS [OrderRank],
      -1 AS [OrderRank],
      0 AS [EventClass],
      0 [DatabaseName],
      0 AS [Filename],
      0 AS [Duration],
      0 AS [StartTime],
      0 AS [EndTime],
      0 AS ChangeInSize
   END    TRY
   BEGIN CATCH
    SELECT
     SERVERPROPERTY('MachineName') AS ComputerName,
     ISNULL(SERVERPROPERTY('InstanceName'), 'MSSQLSERVER') AS InstanceName,
     SERVERPROPERTY('ServerName') AS SqlInstance,
     -100 AS [OrderRank],
     -100 AS [OrderRank],
     ERROR_NUMBER() AS [EventClass],
     ERROR_SEVERITY() AS [DatabaseName],
     ERROR_STATE() AS [Filename],
     ERROR_MESSAGE() AS [Duration],
     1 AS [StartTime],
     1 AS [EndTime],
     1 AS [ChangeInSize]
   END CATCH"

    }
    process {
        foreach ($instance in $SqlInstance) {
            Write-Message -Level Verbose -Message "Attempting to connect to $instance"
            try {
                $server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $SqlCredential
            }
            catch {
                Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue
            }

            $dbs = $server.Databases

            if ($Database) {
                $dbs = $dbs | Where-Object Name -In $Database
            }

            if ($ExcludeDatabase) {
                $dbs = $dbs | Where-Object Name -NotIn $ExcludeDatabase
            }

            #Create dblist name in 'bd1', 'db2' format
            $dbsList = "'$($($dbs | ForEach-Object {$_.Name}) -join "','")'"
            Write-Message -Level Verbose -Message "Executing query against $dbsList on $instance"

            $sql = $sql -replace '_DatabaseList_', $dbsList
            Write-Message -Level Debug -Message "Executing SQL Statement:`n $sql"

            $defaults = 'ComputerName', 'InstanceName', 'SqlInstance', 'EventClass', 'DatabaseName', 'Filename', 'Duration', 'StartTime', 'EndTime', 'ChangeInSize'

            Select-DefaultView -InputObject $server.Query($sql) -Property $defaults
        }
    }
}