Skip to content

Commit 973b460

Browse files
authored
(DOCSP-22423): Clarify startup instructions for redactClientLogData (#2101) (#2108)
* Clarify startup instructions for redactClientLogData * copy review feedback * final fixes
1 parent 58c985c commit 973b460

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
@@ -1920,6 +1920,27 @@ Logging Parameters
19201920
:doc:`/core/security-transport-encryption` to assist compliance with
19211921
regulatory requirements.
19221922

1923+
To enable log redaction at startup, you can either:
1924+
1925+
- Start :binary:`mongod` with the
1926+
:option:`--redactClientLogData <mongod --redactClientLogData>` option:
1927+
1928+
.. code-block:: javascript
1929+
1930+
mongod --redactClientLogData
1931+
1932+
- Set the :setting:`security.redactClientLogData` option in the
1933+
:ref:`configuration file <configuration-options>`:
1934+
1935+
.. code-block:: yaml
1936+
1937+
security:
1938+
redactClientLogData: true
1939+
...
1940+
1941+
You can't use the :option:`--setParameter <mongod --setParameter>`
1942+
option to set :parameter:`redactClientLogData` at startup.
1943+
19231944
To enable log redaction on a running ``mongod`` or
19241945
``mongos``, use the following command:
19251946

0 commit comments

Comments
 (0)