ccr-settings.asciidoc 2.7 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152
  1. [role="xpack"]
  2. [[ccr-settings]]
  3. === {ccr-cap} settings
  4. These {ccr} settings can be dynamically updated on a live cluster with the
  5. <<cluster-update-settings,cluster update settings API>>.
  6. [discrete]
  7. [[ccr-recovery-settings]]
  8. ==== Remote recovery settings
  9. The following setting can be used to rate-limit the data transmitted during
  10. <<ccr-remote-recovery,remote recoveries>>:
  11. `ccr.indices.recovery.max_bytes_per_sec` (<<cluster-update-settings,Dynamic>>)::
  12. Limits the total inbound and outbound remote recovery traffic on each node.
  13. Since this limit applies on each node, but there may be many nodes performing
  14. remote recoveries concurrently, the total amount of remote recovery bytes may be
  15. much higher than this limit. If you set this limit too high then there is a risk
  16. that ongoing remote recoveries will consume an excess of bandwidth (or other
  17. resources) which could destabilize the cluster. This setting is used by both the
  18. leader and follower clusters. For example if it is set to `20mb` on a leader,
  19. the leader will only send `20mb/s` to the follower even if the follower is
  20. requesting and can accept `60mb/s`. Defaults to `40mb`.
  21. [discrete]
  22. [[ccr-advanced-recovery-settings]]
  23. ==== Advanced remote recovery settings
  24. The following _expert_ settings can be set to manage the resources consumed by
  25. remote recoveries:
  26. `ccr.indices.recovery.max_concurrent_file_chunks` (<<cluster-update-settings,Dynamic>>)::
  27. Controls the number of file chunk requests that can be sent in parallel per
  28. recovery. As multiple remote recoveries might already running in parallel,
  29. increasing this expert-level setting might only help in situations where remote
  30. recovery of a single shard is not reaching the total inbound and outbound remote recovery traffic as configured by `ccr.indices.recovery.max_bytes_per_sec`.
  31. Defaults to `5`. The maximum allowed value is `10`.
  32. `ccr.indices.recovery.chunk_size`(<<cluster-update-settings,Dynamic>>)::
  33. Controls the chunk size requested by the follower during file transfer. Defaults to
  34. `1mb`.
  35. `ccr.indices.recovery.recovery_activity_timeout`(<<cluster-update-settings,Dynamic>>)::
  36. Controls the timeout for recovery activity. This timeout primarily applies on
  37. the leader cluster. The leader cluster must open resources in-memory to supply
  38. data to the follower during the recovery process. If the leader does not receive recovery requests from the follower for this period of time, it will close the resources. Defaults to 60 seconds.
  39. `ccr.indices.recovery.internal_action_timeout` (<<cluster-update-settings,Dynamic>>)::
  40. Controls the timeout for individual network requests during the remote recovery
  41. process. An individual action timing out can fail the recovery. Defaults to
  42. 60 seconds.