functions/Get-DbaSqlLog.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
function Get-DbaSqlLog {
<#
 .SYNOPSIS
  Gets the "SQL Error Log" of an instance
 
 .DESCRIPTION
  Gets the "SQL Error Log" of an instance. Returns all 10 error logs by default.
 
 .PARAMETER SqlInstance
  The SQL Server instance, or instances.
 
 .PARAMETER SqlCredential
  Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted.
 
 .PARAMETER LogNumber
  An Int32 value that specifies the index number of the error log required.
  Error logs are listed 0 through 99, where 0 is the current error log and 99 is potential oldest log file.
 
  SQL Server errorlog rollover defaults to 6, but can be increased to 99. https://docs.microsoft.com/en-us/sql/database-engine/configure-windows/scm-services-configure-sql-server-error-logs
 
 .PARAMETER Source
  Filter results based on the Source of the error (e.g. Logon, Server, etc.)
 
 .PARAMETER Text
  Filter results based on a pattern of text (e.g. "login failed", "error: 12345").
 
 .PARAMETER After
  Filter the results based on datetime value.
 
 .PARAMETER Before
  Filter the results based on datetime value.
 
 .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: Logging
  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-DbaSqlLog
 
 .EXAMPLE
  Get-DbaSqlLog -SqlInstance sql01\sharepoint
 
  Returns every log entry from sql01\sharepoint SQL Server instance.
 
 .EXAMPLE
  Get-DbaSqlLog -SqlInstance sql01\sharepoint -LogNumber 3, 6
 
  Returns all log entries for log number 3 and 6 on sql01\sharepoint SQL Server instance.
 
 .EXAMPLE
  Get-DbaSqlLog -SqlInstance sql01\sharepoint -Source Logon
 
  Returns every log entry, with a source of Logon, from sql01\sharepoint SQL Server instance.
 
 .EXAMPLE
  Get-DbaSqlLog -SqlInstance sql01\sharepoint -LogNumber 3 -Text "login failed"
 
  Returns every log entry for log number 3, with "login failed" in the text, from sql01\sharepoint SQL Server instance.
 
 .EXAMPLE
  $servers = "sql2014","sql2016", "sqlcluster\sharepoint"
  $servers | Get-DbaSqlLog -LogNumber 0
 
  Returns the most recent SQL Server error logs for "sql2014","sql2016" and "sqlcluster\sharepoint"
 
 .EXAMPLE
  Get-DbaSqlLog -SqlInstance sql01\sharepoint -After '11/14/2006 00:00'
 
  Returns every log entry found after the date 11/14/2006 00:00 from sql101\sharepoint SQL Server instance.
 
 .EXAMPLE
  Get-DbaSqlLog -SqlInstance sql01\sharepoint -Before '08/16/2016 00:00'
 
  Returns every log entry found before the date 08/16/2016 00:00 from sql101\sharepoint SQL Server instance.
 #>

    [CmdletBinding()]
    param (
        [Parameter(ValueFromPipeline = $true)]
        [Alias("ServerInstance", "SqlServer")]
        [DbaInstanceParameter[]]$SqlInstance,
        [Alias("Credential")]
        [PSCredential]$SqlCredential,
        [ValidateRange(0, 99)]
        [int[]]$LogNumber,
        [object[]]$Source,
        [string]$Text,
        [datetime]$After,
        [datetime]$Before,
        [switch][Alias('Silent')]$EnableException
    )
    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
            }

            if ($LogNumber) {
                foreach ($number in $lognumber) {
                    foreach ($object in $server.ReadErrorLog($number)) {
                        if ( ($Source -and $object.ProcessInfo -ne $Source) -or ($Text -and $object.Text -notlike "*$Text*") -or ($After -and $object.LogDate -lt $After) -or ($Before -and $object.LogDate -gt $Before) ) {
                            continue
                        }
                        Write-Message -Level Verbose -Message "Processing $object"
                        Add-Member -Force -InputObject $object -MemberType NoteProperty ComputerName -value $server.NetName
                        Add-Member -Force -InputObject $object -MemberType NoteProperty InstanceName -value $server.ServiceName
                        Add-Member -Force -InputObject $object -MemberType NoteProperty SqlInstance -value $server.DomainInstanceName

                        # Select all of the columns you'd like to show
                        Select-DefaultView -InputObject $object -Property ComputerName, InstanceName, SqlInstance, LogDate, 'ProcessInfo as Source', Text
                    }
                }
            }
            else {
                foreach ($object in $server.ReadErrorLog()) {
                    if ( ($Source -and $object.ProcessInfo -ne $Source) -or ($Text -and $object.Text -notlike "*$Text*") -or ($After -and $object.LogDate -lt $After) -or ($Before -and $object.LogDate -gt $Before) ) {
                        continue
                    }
                    Write-Message -Level Verbose -Message "Processing $object"
                    Add-Member -Force -InputObject $object -MemberType NoteProperty ComputerName -value $server.NetName
                    Add-Member -Force -InputObject $object -MemberType NoteProperty InstanceName -value $server.ServiceName
                    Add-Member -Force -InputObject $object -MemberType NoteProperty SqlInstance -value $server.DomainInstanceName

                    # Select all of the columns you'd like to show
                    Select-DefaultView -InputObject $object -Property ComputerName, InstanceName, SqlInstance, LogDate, 'ProcessInfo as Source', Text
                }
            }
        }
    }
}