sp_cycle_agent_errorlog (Transact-SQL)

Applies to: yesSQL Server (all supported versions)

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 has been created.

Topic link icon Transact-SQL Syntax Conventions

Syntax

  
sp_cycle_agent_errorlog  

Return Code Values

0 (success) or 1 (failure)

Result Sets

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  

See Also

sp_cycle_errorlog (Transact-SQL)