functions/Measure-DbaBackupThroughput.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
function Measure-DbaBackupThroughput
{
<#
.SYNOPSIS
Determines how quickly SQL Server is backing up databases to media.
 
.DESCRIPTION
Returns backup history details for some or all databases on a SQL Server.
 
Output looks like this
SqlInstance : sql2016
Database : SharePoint_Config
AvgThroughputMB : 1.07
AvgSizeMB : 24.17
AvgDuration : 00:00:01.1000000
MinThroughputMB : 0.02
MaxThroughputMB : 2.26
MinBackupDate : 8/6/2015 10:22:01 PM
MaxBackupDate : 6/19/2016 12:57:45 PM
BackupCount : 10
 
.PARAMETER SqlInstance
SqlInstance name or SMO object representing the SQL Server to connect to.
This can be a collection and receive pipeline input.
 
.PARAMETER SqlCredential
PSCredential object to connect as. If not specified, current Windows login will be used.
 
.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 Type
By default, this command measures the speed of Full backups. You can also specify Log or Differential.
 
.PARAMETER Since
Datetime object used to narrow the results to a date
 
.PARAMETER Last
Measure only the last backup
 
.PARAMETER DeviceType
Filters the backup set by this DeviceType. It takes well-known types ('Disk','Permanent Disk Device', 'Tape', 'Permanent Tape Device','Pipe','Permanent Pipe Device','Virtual Device') as well as custom integers (bring your own types)
 
.PARAMETER Silent
Replaces user friendly yellow warnings with bloody red exceptions of doom!
Use this if you want the function to throw terminating errors you want to catch.
 
.NOTES
Tags: DisasterRecovery, Backup, Databases
 
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/Measure-DbaBackupThroughput
 
.EXAMPLE
Measure-DbaBackupThroughput -SqlInstance sql2016
 
Parses every backup in msdb's backuphistory for stats on all databases
 
.EXAMPLE
Measure-DbaBackupThroughput -SqlInstance sql2016 -Database AdventureWorks2014
 
Parses every backup in msdb's backuphistory for stats on AdventureWorks2014
     
.EXAMPLE
Measure-DbaBackupThroughput -SqlInstance sql2005 -Last
 
Processes the last full, diff and log backups every backup for all databases on sql2005
     
.EXAMPLE
Measure-DbaBackupThroughput -SqlInstance sql2005 -Last -Type Log
     
Processes the last log backups every backup for all databases on sql2005
 
.EXAMPLE
Measure-DbaBackupThroughput -SqlInstance sql2016 -Since (Get-Date).AddDays(-7)
     
Gets backup calculations for the last week
     
.EXAMPLE
Measure-DbaBackupThroughput -SqlInstance sql2016 -Since (Get-Date).AddDays(-365) -Database bigoldb
     
Gets backup calculations, limited to the last year and only the bigoldb database
 
#>

    [CmdletBinding()]
    param (
        [parameter(Position = 0, Mandatory = $true, ValueFromPipeline = $True)]
        [Alias("ServerInstance", "Instance", "SqlServer")]
        [DbaInstanceParameter[]]$SqlInstance,
        [Alias("Credential")]
        [PSCredential]
        $SqlCredential,
        [Alias("Databases")]
        [object[]]$Database,
        [object[]]$ExcludeDatabase,
        [datetime]$Since,
        [switch]$Last,
        [ValidateSet("Full", "Log", "Differential", "File", "Differential File", "Partial Full", "Partial Differential")]
        [string]$Type = "Full",
        [string[]]$DeviceType,
        [switch]$Silent
    )
    
    process
    {
        foreach ($instance in $SqlInstance)
        {
            try {
                Write-Message -Level Verbose -Message "Connecting to $instance"
                $server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $sqlcredential
            }
            catch {
                Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue
            }
            
            if ($Database) {
                $DatabaseCollection = $server.Databases | Where-Object Name -in $Database
            }
            else {
                $DatabaseCollection = $server.Databases
            }
            
            if ($ExcludeDatabase) {
                $DatabaseCollection = $DatabaseCollection | Where-Object Name -NotIn $ExcludeDatabase
            }
            
            foreach ($db in $DatabaseCollection)
            {
                Write-Message -Level VeryVerbose -Message "Retrieving history for $db"
                $allhistory = @()
                
                # Splatting didn't work
                if ($since)
                {    
                    $histories = Get-DbaBackupHistory -SqlInstance $server -Database $db -Since $since -DeviceType $DeviceType | Where-Object Type -eq $Type
                }
                else
                {
                    $histories = Get-DbaBackupHistory -SqlInstance $server -Database $db -Last:$last -DeviceType $DeviceType | Where-Object Type -eq $Type
                }
                
                foreach ($history in $histories)
                {
                    $timetaken = New-TimeSpan -Start $history.Start -End $history.End
                    
                    if ($timetaken.TotalMilliseconds -eq 0)
                    {
                        $throughput = $history.TotalSize.Megabyte
                    }
                    else
                    {
                        $throughput = $history.TotalSize.Megabyte / $timetaken.TotalSeconds
                    }
                    
                    Add-Member -Force -InputObject $history -MemberType Noteproperty -Name MBps -value $throughput
                    
                    $allhistory += $history | Select-Object ComputerName, InstanceName, SqlInstance, Database, MBps, TotalSize, Start, End
                }
                Write-Message -Level VeryVerbose -Message "Calculating averages for $db"
                foreach ($db in ($allhistory | Sort-Object Database | Group-Object Database))
                {
                    $measuremb = $db.Group.MBps | Measure-Object -Average -Minimum -Maximum
                    $measurestart = $db.Group.Start | Measure-Object -Minimum
                    $measureend = $db.Group.End | Measure-Object -Maximum
                    $measuresize = $db.Group.TotalSize.Megabyte | Measure-Object -Average
                    $avgduration = $db.Group | ForEach-Object { New-TimeSpan -Start $_.Start -End $_.End } | Measure-Object -Average TotalSeconds
                    
                    [pscustomobject]@{
                        ComputerName = $db.Group.ComputerName | Select-Object -First 1
                        InstanceName = $db.Group.InstanceName | Select-Object -First 1
                        SqlInstance = $db.Group.SqlInstance | Select-Object -First 1
                        Database = $db.Name
                        AvgThroughputMB = [System.Math]::Round($measuremb.Average, 2)
                        AvgSizeMB = [System.Math]::Round($measuresize.Average, 2)
                        AvgDuration = [dbatimespan](New-TimeSpan -Seconds $avgduration.Average)
                        MinThroughputMB = [System.Math]::Round($measuremb.Minimum, 2)
                        MaxThroughputMB = [System.Math]::Round($measuremb.Maximum, 2)
                        MinBackupDate = [dbadatetime]$measurestart.Minimum
                        MaxBackupDate = [dbadatetime]$measureend.Maximum
                        BackupCount = $db.Count
                    } | Select-DefaultView -ExcludeProperty ComputerName, InstanceName
                }
            }
        }
    }
}