[DOCS-15370] Investigate changes in SERVER-65728: Audit cluster server parameters on startup, update, and retrieval Created: 27/May/22  Updated: 13/Nov/23  Due: 29/Oct/22  Resolved: 25/Oct/22

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: 6.1.0
Fix Version/s: 6.1.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: Joseph Dougherty
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-65728 Audit cluster server parameters on st... Closed
Participants:
Days since reply: 1 year, 8 weeks, 2 days ago
Epic Link: DOCSP-21764

 Description   
Original Downstream Change Summary

We now have 3 more audit events that need to be documented, and one existing audit event that now has one more field than it previously did.

The new audit event `atype`s are `getClusterParameter`, `setClusterParameter`, and `updateCachedClusterServerParameter`.

For `getClusterParameter`, the param is `

{ "requestedClusterServerParameters": <requested parameters> }

`. The result is always 0 - success.

For `setClusterParameter`, the param is `

{ "originalClusterServerParameter": <old cluster param value>, "updatedClusterServerParameter": <new value set by client> }

`. The result is always 0 - success.

For `updateCachedClusterServerParameter`, the param and result code are the same as for `setClusterParameter`. The difference here is that this event gets audited whenever a parameter is changed in-memory, which may be due to propagation of a `setClusterParameter` command, due to a replication event such as rollback, or (on mongos) due to the periodic refresher learning of new cluster parameter values from the config server.

Additionally, the param for the existing audit event with `atype` `startup` has been changed. Now, the param appears as follows: `

{ startupOptions: <document>, initialClusterServerParameter: <list of documents> }

`. `startupOptions` contains all of the options that the node was started up with (this was previously associated with the field name `options`). `initialClusterServerParameters` contains the initial values of the cluster server parameters that the node has at the end of startup, after they have been loaded from disk (in the case of mongod) or refreshed from the config server (in the case of mongos).

Description of Linked Ticket

We should audit the values of cluster server parameters at startup. We should also audit when any cluster server parameter is updated in-memory via setClusterParameter. Finally, we should audit when cluster server parameters are retrieved via getClusterParameter.



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

Author:

{'name': 'jmd-mongo', 'email': '73852296+jmd-mongo@users.noreply.github.com', 'username': 'jmd-mongo'}

Message: DOCS-15370 documents cluster-related audit event (#2021)

  • DOCS-15370 documents cluster-related audit event
  • DOCS-15370 documents new startup audit event details
  • internal review feedback
Comment by Githook User [ 25/Oct/22 ]

Author:

{'name': 'jmd-mongo', 'email': '73852296+jmd-mongo@users.noreply.github.com', 'username': 'jmd-mongo'}

Message: DOCS-15370 documents cluster-related audit event (#2021)

  • DOCS-15370 documents cluster-related audit event
  • DOCS-15370 documents new startup audit event details
  • internal review feedback
Comment by Education Bot [ 27/May/22 ]

Fix Version updated for upstream SERVER-65728:
6.1.0-rc0

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