This version of the OpenSearch documentation is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Replication settings

The replication plugin adds several settings to the standard OpenSearch cluster settings. The settings are dynamic, so you can change the default behavior of the plugin without restarting your cluster. You can mark settings as persistent or transient.

For example, to update how often the follower cluster polls the leader cluster for updates:

  1. PUT _cluster/settings
  2. {
  3. "persistent": {
  4. "plugins.replication.follower.metadata_sync_interval": "30s"
  5. }
  6. }

These settings manage the resources consumed by remote recoveries. We don’t recommend changing these settings; the defaults should work well for most use cases.

SettingDefaultDescription
plugins.replication.follower.index.recovery.chunk_size10 MBThe chunk size requested by the follower cluster during file transfer. Specify the chunk size as a value and unit, for example, 10 MB, 5 KB. See Supported units.
plugins.replication.follower.index.recovery.max_concurrent_file_chunks4The number of file chunk requests that can be sent in parallel for each recovery.
plugins.replication.follower.index.ops_batch_size50000The number of operations that can be fetched at a time during the syncing phase of replication.
plugins.replication.follower.concurrent_readers_per_shard2The number of concurrent requests from the follower cluster per shard during the syncing phase of replication.
plugins.replication.autofollow.fetch_poll_interval30sHow often auto-follow tasks poll the leader cluster for new matching indexes.
plugins.replication.follower.metadata_sync_interval60sHow often the follower cluster polls the leader cluster for updated index metadata.
plugins.replication.translog.retention_lease.pruning.enabledtrueIf enabled, prunes the translog based on retention leases on the leader index.
plugins.replication.translog.retention_size512 MBControls the size of the translog on the leader index.