Skip to content

Commit bea78cd

Browse files
authored
(DOCSP-22423): Clarify startup instructions for redactClientLogData (#2101) (#2109)
* Clarify startup instructions for redactClientLogData * copy review feedback * final fixes
1 parent 2a47c20 commit bea78cd

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
@@ -1747,6 +1747,27 @@ Logging Parameters
17471747
:doc:`/core/security-transport-encryption` to assist compliance with
17481748
regulatory requirements.
17491749

1750+
To enable log redaction at startup, you can either:
1751+
1752+
- Start :binary:`mongod` with the
1753+
:option:`--redactClientLogData <mongod --redactClientLogData>` option:
1754+
1755+
.. code-block:: javascript
1756+
1757+
mongod --redactClientLogData
1758+
1759+
- Set the :setting:`security.redactClientLogData` option in the
1760+
:ref:`configuration file <configuration-options>`:
1761+
1762+
.. code-block:: yaml
1763+
1764+
security:
1765+
redactClientLogData: true
1766+
...
1767+
1768+
You can't use the :option:`--setParameter <mongod --setParameter>`
1769+
option to set :parameter:`redactClientLogData` at startup.
1770+
17501771
To enable log redaction on a running ``mongod`` or
17511772
``mongos``, use the following command:
17521773

0 commit comments

Comments
 (0)