Skip to content

Commit 4ace17b

Browse files
authored
(DOCSP-22423): Clarify startup instructions for redactClientLogData (#2101)
* Clarify startup instructions for redactClientLogData * copy review feedback * final fixes
1 parent 7861c1d commit 4ace17b

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
@@ -1949,6 +1949,27 @@ Logging Parameters
19491949
:doc:`/core/security-transport-encryption` to assist compliance with
19501950
regulatory requirements.
19511951

1952+
To enable log redaction at startup, you can either:
1953+
1954+
- Start :binary:`mongod` with the
1955+
:option:`--redactClientLogData <mongod --redactClientLogData>` option:
1956+
1957+
.. code-block:: javascript
1958+
1959+
mongod --redactClientLogData
1960+
1961+
- Set the :setting:`security.redactClientLogData` option in the
1962+
:ref:`configuration file <configuration-options>`:
1963+
1964+
.. code-block:: yaml
1965+
1966+
security:
1967+
redactClientLogData: true
1968+
...
1969+
1970+
You can't use the :option:`--setParameter <mongod --setParameter>`
1971+
option to set :parameter:`redactClientLogData` at startup.
1972+
19521973
To enable log redaction on a running ``mongod`` or
19531974
``mongos``, use the following command:
19541975

0 commit comments

Comments
 (0)