Skip to content

Commit 99ad7d4

Browse files
authored
(DOCSP-22423): Clarify startup instructions for redactClientLogData (#2101) (#2110)
* Clarify startup instructions for redactClientLogData * copy review feedback * final fixes
1 parent 287703b commit 99ad7d4

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

source/reference/parameters.txt

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1699,6 +1699,27 @@ Logging Parameters
16991699
:doc:`/core/security-transport-encryption` to assist compliance with
17001700
regulatory requirements.
17011701

1702+
To enable log redaction at startup, you can either:
1703+
1704+
- Start :binary:`mongod` with the
1705+
:option:`--redactClientLogData <mongod --redactClientLogData>` option:
1706+
1707+
.. code-block:: javascript
1708+
1709+
mongod --redactClientLogData
1710+
1711+
- Set the :setting:`security.redactClientLogData` option in the
1712+
:ref:`configuration file <configuration-options>`:
1713+
1714+
.. code-block:: yaml
1715+
1716+
security:
1717+
redactClientLogData: true
1718+
...
1719+
1720+
You can't use the :option:`--setParameter <mongod --setParameter>`
1721+
option to set :parameter:`redactClientLogData` at startup.
1722+
17021723
To enable log redaction on a running ``mongod`` or
17031724
``mongos``, use the following command:
17041725

0 commit comments

Comments
 (0)