Skip to content

Commit 624d2d8

Browse files
Explain the importance of checkpointing for backups (#1793)
Co-authored-by: Reneta Popova <[email protected]>
1 parent bb4073f commit 624d2d8

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

modules/ROOT/pages/backup-restore/online-backup.adoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -217,6 +217,22 @@ The error codes include details of what error was encountered.
217217
[[online-backup-configurations]]
218218
== Online backup configurations
219219

220+
[[online-backup-checkpoints]]
221+
=== Checkpointing
222+
223+
When a full backup is requested, it always triggers a checkpoint.
224+
The backup cannot proceed until the checkpoint finishes.
225+
226+
While the server is checkpointing, the backup job receives no data, which may lead to the backup timeout.
227+
To extend the backup timeout, modify the xref:configuration/configuration-settings.adoc#config_dbms.cluster.catchup.client_inactivity_timeout[`dbms.cluster.catchup.client_inactivity_timeout`] setting, which restricts the network inactivity.
228+
It controls the timeout duration of the catchup protocol, which is the underlying protocol of multiple catchup processes, including backups.
229+
230+
You can also tune up xref:configuration/configuration-settings.adoc#_checkpoint_settings[the Checkpoint settings] or check that your disks are performant enough to handle the load.
231+
For more information, see xref:performance/disks-ram-and-other-tips.adoc#performance-checkpoint-iops-limit[Checkpoint IOPS limit].
232+
233+
To read more about checkpointing, see xref:database-internals/checkpointing.adoc[Database internals -> Checkpointing and log pruning].
234+
235+
220236
[[backup-server-configuration]]
221237
=== Server configuration
222238

0 commit comments

Comments
 (0)