sp_replication_agent_checkup (Transact-SQL)

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

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

Topic link icon Transact-SQL Syntax Conventions

Syntax


sp_replication_agent_checkup [ [ @heartbeat_interval = ] heartbeat_interval ]  

Arguments

[ @heartbeat_interval = ] 'heartbeat_interval'
Is 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.

See Also

System Stored Procedures (Transact-SQL)