sp_replication_agent_checkup (Transact-SQL)

Applies to: SQL Server Azure SQL Managed Instance

Checks each distribution database for replication agents that are running but haven't logged history within the specified heartbeat interval. This stored procedure is executed at the Distributor on any database.

Transact-SQL syntax conventions

Syntax

syntaxsql

sp_replication_agent_checkup [ [ @heartbeat_interval = ] heartbeat_interval ]
[ ; ]

Arguments

[ @heartbeat_interval = ] heartbeat_interval

The maximum number of minutes that an agent can go without logging a progress message. @heartbeat_interval is int, with a default of 10 minutes.

Return code values

sp_replication_agent_checkup raises error 14151 for each agent it detects as suspect. It also logs a failure history message about the agents.

Remarks

sp_replication_agent_checkup is used in snapshot replication, transactional replication, and merge replication.

Permissions

Only members of the sysadmin fixed server role can execute sp_replication_agent_checkup.

Related content

• System stored procedures (Transact-SQL)