Get-DbaAgentLog

Synopsis

Retrieves SQL Server Agent error log entries for troubleshooting and monitoring

Description

Retrieves SQL Server Agent error log entries from the target instance, providing detailed information about agent service activity, job failures, and system events. This function accesses the agent’s historical error logs (numbered 0-9, where 0 is the current log) so you don’t have to manually navigate through SQL Server Management Studio or query system views. Essential for troubleshooting job failures, monitoring agent service health, and compliance auditing of automated processes.

Syntax

Get-DbaAgentLog
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-LogNumber] <Int32[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaAgentLog -SqlInstance sql01\sharepoint

Returns the entire error log for the SQL Agent on sql01\sharepoint

Example: 2

PS C:\> Get-DbaAgentLog -SqlInstance sql01\sharepoint -LogNumber 3, 6

Returns log numbers 3 and 6 for the SQL Agent on sql01\sharepoint

Example: 3

PS C:\> $servers = "sql2014","sql2016", "sqlcluster\sharepoint"
PS C:\> $servers | Get-DbaAgentLog -LogNumber 0

Returns the most recent SQL Agent error logs for “sql2014”,“sql2016” and “sqlcluster\sharepoint”

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.

-LogNumber

Specifies which numbered agent error log files to retrieve (0-9). Log 0 contains the most recent entries, while higher numbers contain older historical logs that get cycled as new logs are created.
Use this when you need to examine historical agent activity or troubleshoot issues that occurred days or weeks ago, rather than just current entries.

-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.