Skip to content

Commit 70bca65

Browse files
Document the 'wal_cleanup_delay' option (#3350)
Document the 'wal_cleanup_delay' option. Resolves #2022
1 parent dd7c1d7 commit 70bca65

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

doc/reference/configuration/cfg_binary_logging_snapshots.rst

+26
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
* :ref:`wal_mode <cfg_binary_logging_snapshots-wal_mode>`
55
* :ref:`wal_dir_rescan_delay <cfg_binary_logging_snapshots-wal_dir_rescan_delay>`
66
* :ref:`wal_queue_max_size <cfg_binary_logging_snapshots-wal_queue_max_size>`
7+
* :ref:`wal_cleanup_delay <cfg_binary_logging_snapshots-wal_cleanup_delay>`
78

89
.. _cfg_binary_logging_snapshots-force_recovery:
910

@@ -111,3 +112,28 @@
111112
| Default: 16777216 bytes
112113
| Environment variable: TT_WAL_QUEUE_MAX_SIZE
113114
| Dynamic: **yes**
115+
116+
.. _cfg_binary_logging_snapshots-wal_cleanup_delay:
117+
118+
.. confval:: wal_cleanup_delay
119+
120+
Since version :doc:`2.6.3 </release/2.6.3>`.
121+
The delay (in seconds) used to prevent the :ref:`Tarantool garbage collector <cfg_checkpoint_daemon-garbage-collector>`
122+
from immediately removing :ref:`write-ahead log<internals-wal>` files after a node restart.
123+
This delay eliminates possible erroneous situations when the master deletes WALs
124+
needed by :ref:`replicas <replication-roles>` after restart.
125+
As a consequence, replicas sync with the master faster after its restart and
126+
don't need to download all the data again.
127+
128+
Once all the nodes in the replica set are up and running,
129+
automatic cleanup is started again even if ``wal_cleanup_delay`` has not expired.
130+
131+
.. NOTE::
132+
133+
The ``wal_cleanup_delay`` option has no effect on nodes running as
134+
:ref:`anonymous replicas<cfg_replication-replication_anon>`.
135+
136+
| Type: number
137+
| Default: 14400 seconds
138+
| Environment variable: TT_WAL_CLEANUP_DELAY
139+
| Dynamic: **yes**

0 commit comments

Comments
 (0)