sp-replication-agent-checkup-transact-sql.md

title	sp_replication_agent_checkup (Transact-SQL) | Microsoft Docs
ms.custom
ms.date	03/04/2017
ms.prod	sql
ms.prod_service	database-engine
ms.reviewer
ms.technology	replication
ms.topic	language-reference
f1_keywords	sp_replication_agent_checkup_TSQL sp_replication_agent_checkup
helpviewer_keywords	sp_replication_agent_checkup
ms.assetid	50357c2e-71aa-4e13-9e2e-0977a3655cc9
author	MashaMSFT
ms.author	mathoma

sp_replication_agent_checkup (Transact-SQL)

[!INCLUDEappliesto-ss-asdbmi-xxxx-xxx-md]

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.

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)