Skip to content

Commit 0602835

Browse files
authored
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 * release notes linking improvement
1 parent 51fd765 commit 0602835

File tree

3 files changed

+69
-6
lines changed

3 files changed

+69
-6
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.. code-block:: none
2+
:copyable: false
3+
4+
{
5+
originalClusterServerParameter: <original parameter value>,
6+
updatedClusterServerParameter": <new parameter value>
7+
}

source/reference/audit-message.txt

Lines changed: 44 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -505,6 +505,36 @@ associated ``param`` details and the ``result`` values, if any.
505505

506506
- ``0`` - Success
507507

508+
* - .. _audit-message-getClusterParameter:
509+
510+
``getClusterParameter``
511+
- .. code-block:: none
512+
:copyable: false
513+
514+
{
515+
requestedClusterServerParameters: <parameters>
516+
}
517+
- ``0`` - Success
518+
519+
* - .. _audit-message-setClusterParameter:
520+
521+
``setClusterParameter``
522+
- .. include:: /includes/fact-audit-message-setClusterParameter-form.rst
523+
- ``0`` - Success
524+
525+
* - .. _audit-message-updateCachedClusterServerParameter:
526+
527+
``updateCachedClusterServerParameter``
528+
- .. include:: /includes/fact-audit-message-setClusterParameter-form.rst
529+
530+
Logged when a parameter is changed because of:
531+
532+
- Propagation of a ``setClusterParameter`` command
533+
- Replication event such as rollback
534+
- A refresh of new cluster parameter values from the config
535+
server on ``mongos``
536+
- ``0`` - Success
537+
508538
* - ``updateUser``
509539

510540
- .. code-block:: none
@@ -896,16 +926,24 @@ associated ``param`` details and the ``result`` values, if any.
896926
* - .. _audit-message-startup:
897927

898928
``startup``
899-
900929
- .. code-block:: none
901930
:copyable: false
902931

903-
{ options: <document> }
932+
{
933+
startupOptions: <document>,
934+
initialClusterServerParameter: <array of documents>
935+
}
936+
937+
- ``startupOptions`` contains all of the options that the node
938+
has after startup
939+
- ``initialClusterServerParameters`` contains the initial values
940+
of the cluster server parameters that the node has at the end
941+
of startup:
904942

905-
The ``options`` document contains the options the instance was
906-
started with.
943+
- after they have been loaded from storage (for ``mongod``)
944+
- after they have been refreshed from the config server
945+
(for ``mongos``).
907946

908947
.. versionadded:: 5.0
909-
910-
948+
.. versionchanged:: 6.1
911949
- ``0`` - Success

source/release-notes/6.1.txt

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -361,6 +361,24 @@ Starting in MongoDB 6.1, the aggregation stages :pipeline:`$addFields` and
361361
:pipeline:`$set` allow you to set paths to empty objects without using the
362362
:expression:`$literal` expression.
363363

364+
365+
Auditing
366+
~~~~~~~~
367+
368+
MongoDB 6.1 adds the following cluster audit events:
369+
370+
- :ref:`getClusterParameter <audit-message-getClusterParameter>`
371+
- :ref:`setClusterParameter <audit-message-setClusterParameter>`
372+
- :ref:`updateCachedClusterServerParameter
373+
<audit-message-updateCachedClusterServerParameter>`
374+
375+
Starting in MongoDB 6.1, the :ref:`startup <audit-message-startup>`
376+
audit event has this structure:
377+
378+
.. include:: /includes/fact-audit-message-setClusterParameter-form.rst
379+
380+
For additional details, see :ref:`audit-action-details-results`.
381+
364382
Server Parameters
365383
-----------------
366384

0 commit comments

Comments
 (0)