[DOCS-15230] Investigate changes in SERVER-61802: Document changeStreamOptions parameter Created: 12/Apr/22  Updated: 13/Nov/23  Resolved: 07/Jul/22

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 6.0.0-rc0, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Task Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: Jocelyn Mendez
Resolution: Fixed Votes: 0
Labels: mdb-world-required
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-61802 Implement pre-image expiration config... Closed
Participants:
Days since reply: 1 year, 30 weeks, 1 day ago
Epic Link: DOCSP-19446

 Description   
Original Downstream Change Summary

This PR introduces a new cluster-wide server parameter, which will be the first one supported by the server. The parameter is called changeStreamOptions and will look as follows in 6.0:

changeStreamOptions: {preAndPostImages: {expireAfterSeconds: <'off' | <integer>>}}

By default, changeStreamOptions.preAndPostImages.expireAfterSeconds is 'off', meaning that the pre-image time-based retention policy is not active. It can be set to an integer, which turns on the time-based policy such that pre-images are kept on the server for 'expireAfterSeconds' seconds.

Ex: to retain pre-images for change streams for 30 seconds each, invoke setClusterParameter as follows:
db.runCommand({setClusterParameter: {changeStreamOptions: {preAndPostImages: {expireAfterSeconds: 30}}}})
This only should be run on a mongos in a sharded cluster or on a replica set primary on a non-sharded replica set. The value will be set cluster-wide.

To retrieve any cluster node's value for changeStreamOptions, run the following command:
db.runCommand(

{getClusterParameter: "changeStreamOptions"}

)

Description of Linked Ticket

In PM-1944 a cluster-wide configuration parameter was added to provide control on how much time can pass after the change event occurrence when the system can purge any state required to provide pre- and post-images for the change event. Implement propagation throughout the cluster and persistence aspects of that parameter by leveraging mechanisms provided by PM-2502 (Mechanism for Specifying Cluster-Wide Configuration Options).

Additional scope:

  • Enable the feature flag that guards the configuration parameter, so the time-based change stream pre-image retention policy becomes accessible to the users.
  • Create a task to remove the feature flag referred to above.

The parameter was introduced by SERVER-58692.



 Comments   
Comment by Githook User [ 12/Jul/22 ]

Author:

{'name': 'jocelyn-mendez1', 'email': '91144778+jocelyn-mendez1@users.noreply.github.com', 'username': 'jocelyn-mendez1'}

Message: DOCS-15230 changeStreamOptions cluster parameter (#1149)

  • DOCS-15230 changeStreamOptions cluster parameter

Co-authored-by: Jocelyn Mendez <jocelyn.mendez@Jocelyns-MacBook-Pro.local>
Branch: v6.1
https://github.com/10gen/docs-mongodb-internal/commit/df35f1f57ccf41dfbfc40b0c730a5d122957223c

Comment by Githook User [ 30/Jun/22 ]

Author:

{'name': 'jocelyn-mendez1', 'email': '91144778+jocelyn-mendez1@users.noreply.github.com', 'username': 'jocelyn-mendez1'}

Message: DOCS-15230 changeStreamOptions cluster parameter (#1149)

  • DOCS-15230 changeStreamOptions cluster parameter

Co-authored-by: Jocelyn Mendez <jocelyn.mendez@Jocelyns-MacBook-Pro.local>
Branch: master
https://github.com/10gen/docs-mongodb-internal/commit/df35f1f57ccf41dfbfc40b0c730a5d122957223c

Comment by Jess Mokrzecki [ 12/Apr/22 ]

Fix Version updated for upstream SERVER-61802:
6.0.0-rc0

Generated at Thu Feb 08 08:12:20 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.