Skip to content

Commit fa1ee52

Browse files
authored
(DOCSP-22423): Clarify startup instructions for redactClientLogData (#2101) (#2111)
* Clarify startup instructions for redactClientLogData * copy review feedback * final fixes
1 parent 1008799 commit fa1ee52

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
@@ -1338,6 +1338,27 @@ Logging Parameters
13381338
:doc:`/core/security-transport-encryption` to assist compliance with
13391339
regulatory requirements.
13401340

1341+
To enable log redaction at startup, you can either:
1342+
1343+
- Start :binary:`mongod` with the
1344+
:option:`--redactClientLogData <mongod --redactClientLogData>` option:
1345+
1346+
.. code-block:: javascript
1347+
1348+
mongod --redactClientLogData
1349+
1350+
- Set the :setting:`security.redactClientLogData` option in the
1351+
:ref:`configuration file <configuration-options>`:
1352+
1353+
.. code-block:: yaml
1354+
1355+
security:
1356+
redactClientLogData: true
1357+
...
1358+
1359+
You can't use the :option:`--setParameter <mongod --setParameter>`
1360+
option to set :parameter:`redactClientLogData` at startup.
1361+
13411362
To enable log redaction on a running ``mongod`` or
13421363
``mongos``, use the following command:
13431364

0 commit comments

Comments
 (0)