[SERVER-46291] Deprecate wiredTigerMaxCacheOverflowFileSizeGB server parameter Created: 21/Feb/20  Updated: 29/Oct/23  Resolved: 07/May/20

Status: Closed
Project: Core Server
Component/s: Storage
Affects Version/s: None
Fix Version/s: 4.4.0-rc5, 4.7.0

Type: Bug Priority: Major - P3
Reporter: Sulabh Mahajan Assignee: Benety Goh
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Backports
Depends
depends on WT-5585 Remove cache_overflow config option Closed
Documented
is documented by DOCS-13632 Investigate changes in SERVER-46291: ... Closed
Related
is related to SERVER-39004 Introduce a quota mechanism for the o... Closed
Backwards Compatibility: Fully Compatible
Backport Requested:
v4.4
Sprint: Execution Team 2020-05-04, Execution Team 2020-05-18
Participants:
Linked BF Score: 0

 Description   

The WiredTiger cache overflow file has been removed in 4.4, so this configuration option doesn't make work any more - we should deprecate it. There are a number of users who set this configuration option - so we should be nice to them when doing this work.



 Comments   
Comment by Githook User [ 07/May/20 ]

Author:

{'name': 'Benety Goh', 'email': 'benety@mongodb.com', 'username': 'benety'}

Message: SERVER-46291 make --wiredTigerMaxCacheOverflowFileSizeGB a noop

(cherry picked from commit 69800d419cf4caf4c0e0772fe2452e537cdd9991)
(cherry picked from commit c9377c36bf9d459b4c41a28f082770b9c5a0369c)
(cherry picked from commit 2b950ff50f9eb071398391f90fb87fca2b85a9e0)
(cherry picked from commit 7262763330522b4e3323558cc2f5af0651563768)
(cherry picked from commit d791868f655cbaa1e6e23a63f82b9ffeec432b84)
Branch: v4.4
https://github.com/mongodb/mongo/commit/595fd0eec4e21b26d29e85594dcf82599550aa73

Comment by Githook User [ 07/May/20 ]

Author:

{'name': 'Benety Goh', 'email': 'benety@mongodb.com', 'username': 'benety'}

Message: SERVER-46291 add WiredTigerGlobalOptions::getMaxHistoryFileSizeMB()

(cherry picked from commit 518824e2c83e2dbd2a3ccca43ab3ce8b647dc91a)
Branch: v4.4
https://github.com/mongodb/mongo/commit/63c9458b3ed5c76c7132459df76b09cfb16ab09b

Comment by Githook User [ 07/May/20 ]

Author:

{'name': 'Benety Goh', 'email': 'benety@mongodb.com', 'username': 'benety'}

Message: SERVER-46291 remove server option and parameter for setting wiredtiger history file
Branch: master
https://github.com/mongodb/mongo/commit/d791868f655cbaa1e6e23a63f82b9ffeec432b84

Comment by Githook User [ 07/May/20 ]

Author:

{'name': 'Benety Goh', 'email': 'benety@mongodb.com', 'username': 'benety'}

Message: SERVER-46291 make --wiredTigerMaxCacheOverflowFileSizeGB a noop
Branch: master
https://github.com/mongodb/mongo/commit/7262763330522b4e3323558cc2f5af0651563768

Comment by Githook User [ 07/May/20 ]

Author:

{'name': 'Benety Goh', 'email': 'benety@mongodb.com', 'username': 'benety'}

Message: Revert "SERVER-46291 make --wiredTigerMaxCacheOverflowFileSizeGB a noop"

This reverts commit 6a836f75daa0d40892f63e4186ac9e2f582bba23.
Branch: master
https://github.com/mongodb/mongo/commit/dd5aab7183ab8342d6c3bd664932dc32d43050a6

Comment by Githook User [ 07/May/20 ]

Author:

{'name': 'Benety Goh', 'email': 'benety@mongodb.com', 'username': 'benety'}

Message: SERVER-46291 make --wiredTigerMaxCacheOverflowFileSizeGB a noop
Branch: master
https://github.com/mongodb/mongo/commit/6a836f75daa0d40892f63e4186ac9e2f582bba23

Comment by Benety Goh [ 05/May/20 ]

SERVER-46291 adds a new startup option —wiredTigerMaxHistoryFileSizeGB (runtime --setParameter wiredTigerMaxHistoryFileSizeGB) to support the durable history project. This allows users to set an upper limit on the growth of the history file, which is the 4.4 equivalent of the cache overflow file. The default setting, similar to the behavior for the cache overflow file in 4.2 and earlier versions, does not impose a limit on the size of the history file and allows the history file to grow unbounded.

For backwards compatibility, the cache overflow startup and runtime options (—wiredTigerMaxCacheOverflowFileSizeGB and —setParameter wiredTigerMaxCacheOverflowSizeGB, introduced in SERVER-39004) have been modified to control the history file settings described above and will produce deprecation warnings in the server logs when used.

Comment by Githook User [ 05/May/20 ]

Author:

{'name': 'Benety Goh', 'email': 'benety@mongodb.com', 'username': 'benety'}

Message: SERVER-46291 add server option and parameter for setting wiredtiger history file

This also aliases and deprecates the previous options for the cache overflow setting.
Branch: master
https://github.com/mongodb/mongo/commit/2b950ff50f9eb071398391f90fb87fca2b85a9e0

Comment by Githook User [ 05/May/20 ]

Author:

{'name': 'Benety Goh', 'email': 'benety@mongodb.com', 'username': 'benety'}

Message: SERVER-46291 update internal references to cache overflow/history file server parameter
Branch: master
https://github.com/mongodb/mongo/commit/c9377c36bf9d459b4c41a28f082770b9c5a0369c

Comment by Githook User [ 05/May/20 ]

Author:

{'name': 'Benety Goh', 'email': 'benety@mongodb.com', 'username': 'benety'}

Message: SERVER-46291 wiredTigerMaxCacheOverflowFileSizeGB server parameter updates history_store.file_max instead of cache_overflow_file_max
Branch: master
https://github.com/mongodb/mongo/commit/69800d419cf4caf4c0e0772fe2452e537cdd9991

Comment by Githook User [ 05/May/20 ]

Author:

{'name': 'Benety Goh', 'email': 'benety@mongodb.com', 'username': 'benety'}

Message: SERVER-46291 add WiredTigerGlobalOptions::getMaxHistoryFileSizeMB()
Branch: master
https://github.com/mongodb/mongo/commit/518824e2c83e2dbd2a3ccca43ab3ce8b647dc91a

Comment by Sulabh Mahajan [ 01/May/20 ]

Yes, all references to cache_overflow should be removed. It used to configure the size of the lookaside file. We do need to replace it with another option to set the size of the history file instead. Are we going to do that as part of this ticket or another one ?

cache_overflow.file_max used to configure the maximum size of lookaside file, is replaced by
history_store.file_max to configure the maximum size of the history file.

Comment by Benety Goh [ 30/Apr/20 ]

We could mark the configuration option as deprecated and hide it from the ./mongod --help output.

sulabh.mahajan, alexander.gorrod, should we also remove the follow references to the cache_overflow option as part of this ticket? This would allow users to continue providing and querying the wiredTigerMaxCacheOverflowFileSizeGB configuration option but make it a no-op as far as the storage engine's configuration is concerned.

Generated at Thu Feb 08 05:11:02 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.