Edit

Share via

sp_cycle_agent_errorlog (Transact-SQL)

  • Article

Applies to: SQL Server

Closes the current SQL Server Agent error log file and cycles the SQL Server Agent error log extension numbers just like a server restart. The new SQL Server Agent error log contains a line indicating that the new log was created.

Transact-SQL syntax conventions

Syntax

sp_cycle_agent_errorlog
[ ; ]

Arguments

None.

Return code values

0 (success) or 1 (failure).

Result set

None.

Remarks

Every time SQL Server Agent is started, the current SQL Server Agent error log is renamed to SQLAgent.1; SQLAgent.1 becomes SQLAgent.2, SQLAgent.2 becomes SQLAgent.3, and so on. sp_cycle_agent_errorlog enables you to cycle the error log files without stopping and starting the server.

This stored procedure must be run from the msdb database.

Permissions

Execute permissions for sp_cycle_agent_errorlog are restricted to members of the sysadmin fixed server role.

Examples

The following example cycles the SQL Server Agent error log.

USE msdb;
GO

EXEC dbo.sp_cycle_agent_errorlog;
GO

Related content