Configure a Secondary’s Sync Target¶

On this page

Overview
Considerations
Procedure

Overview¶

Secondaries capture data from the primary member to maintain an up to date copy of the sets’ data. However, by default secondaries may automatically change their sync targets to secondary members based on changes in the ping time between members and the state of other members’ replication. See Replica Set Data Synchronization and Manage Chained Replication for more information.

For some deployments, implementing a custom replication sync topology may be more effective than the default sync target selection logic. MongoDB provides the ability to specify a host to use as a sync target.

To temporarily override the default sync target selection logic, you may manually configure a secondary member’s sync target to temporarily pull oplog entries. The following provide access to this functionality:

replSetSyncFrom command, or
rs.syncFrom() helper in the mongo shell

Considerations¶

Sync Logic¶

Changed in version 3.4.

If an initial sync operation is in progress when you run replSetSyncFrom/rs.syncFrom(), replSetSyncFrom/rs.syncFrom() stops the in-progress initial sync and restarts the sync process with the new target. In previous versions, if you run replSetSyncFrom/rs.syncFrom() during initial sync, MongoDB produces no error messages, but the sync target will not change until after the initial sync operation.

Only modify the default sync logic as needed, and always exercise caution.

Target¶

The member to sync from must be a valid source for data in the set. To sync from a member, the member must:

Have data. It cannot be an arbiter, in startup or recovering mode, and must be able to answer data queries.
Be accessible.
Be a member of the same set in the replica set configuration.
Build indexes with the members[n].buildIndexes setting.
A different member of the set, to prevent syncing from itself.

If you attempt to replicate from a member that is more than 10 seconds behind the current member, mongod will log a warning but will still replicate from the lagging member. See also Replication Lag and Flow Control.

Persistence¶

replSetSyncFrom/rs.syncFrom() provide a temporary override of default behavior. mongod will revert to the default sync behavior in the following situations:

The mongod instance restarts.
The connection between the mongod and the sync target closes.
If the sync target falls more than 30 seconds behind another member of the replica set.

Procedure¶

To use the replSetSyncFrom command in the mongo shell:

copy

db.adminCommand( { replSetSyncFrom: "hostname<:port>" } );

To use the rs.syncFrom() helper in the mongo shell:

copy

rs.syncFrom("hostname<:port>");

← Change Hostnames in a Replica Set Replication Reference →