Skip to content

Commit cd7c5f6

Browse files
authored
DOCS-15890 Add Log Redaction to Log Messages + Security Page (#2737) (#2838)
* DOCS-15890 Add Log Redaction to Log Messages + Security Page (#2737) * DOCS-15890 Add Log Redaction to Log Messages + Security Page * DC feedback * build errors * build errors again
1 parent 13071dc commit cd7c5f6

File tree

5 files changed

+66
-54
lines changed

5 files changed

+66
-54
lines changed

source/administration/monitoring.txt

Lines changed: 1 addition & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -305,58 +305,7 @@ affect logging:
305305
Log Redaction
306306
~~~~~~~~~~~~~
307307

308-
.. versionadded:: 3.4 Available in MongoDB Enterprise only
309-
310-
A :binary:`~bin.mongod` running with :setting:`security.redactClientLogData`
311-
redacts :doc:`messages </reference/log-messages>` associated with any given
312-
log event before logging, leaving only metadata, source files, or line numbers
313-
related to the event. :setting:`security.redactClientLogData` prevents
314-
potentially sensitive information from entering the system log at the cost of
315-
diagnostic detail.
316-
317-
For example, the following operation inserts a document into a
318-
:binary:`~bin.mongod` running without log redaction. The :binary:`~bin.mongod`
319-
has :setting:`systemLog.component.command.verbosity` set to ``1``:
320-
321-
.. code-block:: javascript
322-
323-
db.clients.insertOne( { "name" : "Joe", "PII" : "Sensitive Information" } )
324-
325-
This operation produces the following log event:
326-
327-
.. code-block:: text
328-
329-
2017-06-09T13:35:23.446-0400 I COMMAND [conn1] command internal.clients
330-
appName: "MongoDB Shell"
331-
command: insert {
332-
insert: "clients",
333-
documents: [ {
334-
_id: ObjectId('593adc5b99001b7d119d0c97'),
335-
name: "Joe",
336-
PII: " Sensitive Information"
337-
} ],
338-
ordered: true
339-
}
340-
...
341-
342-
A :binary:`~bin.mongod` running with :setting:`security.redactClientLogData`
343-
performing the same insert operation produces the following log event:
344-
345-
.. code-block:: text
346-
347-
2017-06-09T13:45:18.599-0400 I COMMAND [conn1] command internal.clients
348-
appName: "MongoDB Shell"
349-
command: insert {
350-
insert: "###", documents: [ {
351-
_id: "###", name: "###", PII: "###"
352-
} ],
353-
ordered: "###"
354-
}
355-
356-
Use :setting:`~security.redactClientLogData` in conjunction with
357-
:doc:`/core/security-encryption-at-rest` and
358-
:doc:`/core/security-transport-encryption` to assist compliance with
359-
regulatory requirements.
308+
.. include:: /includes/fact-log-redaction.rst
360309

361310
Diagnosing Performance Issues
362311
-----------------------------

source/core/security-encryption-at-rest.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _security-encryption-at-rest:
2+
13
==================
24
Encryption at Rest
35
==================
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
*Available in MongoDB Enterprise only*
2+
3+
A :binary:`~bin.mongod` or :binary:`~bin.mongos` running with
4+
:parameter:`redactClientLogData` redacts any message accompanying a given log
5+
event before logging, leaving only metadata, source files, or line numbers
6+
related to the event. :parameter:`redactClientLogData` prevents
7+
potentially sensitive information from entering the system log at the cost of
8+
diagnostic detail.
9+
10+
For example, the following operation inserts a document into a
11+
:binary:`~bin.mongod` running without log redaction. The :binary:`~bin.mongod`
12+
has the :ref:`log verbosity level <log-messages-configure-verbosity>` set to
13+
``1``:
14+
15+
.. code-block:: javascript
16+
17+
db.clients.insertOne( { "name" : "Joe", "PII" : "Sensitive Information" } )
18+
19+
This operation produces the following log event:
20+
21+
.. code-block:: text
22+
23+
2017-06-09T13:35:23.446-04:00 I COMMAND [conn1] command internal.clients
24+
appName: "MongoDB Shell"
25+
command: insert {
26+
insert: "clients",
27+
documents: [ {
28+
_id: ObjectId('593adc5b99001b7d119d0c97'),
29+
name: "Joe",
30+
PII: " Sensitive Information"
31+
} ],
32+
ordered: true
33+
}
34+
...
35+
36+
When :binary:`~bin.mongod` runs with :parameter:`redactClientLogData` and
37+
performs the same insert operation, it produces the following log event:
38+
39+
.. code-block:: text
40+
41+
2017-06-09T13:45:18.599-04:00 I COMMAND [conn1] command internal.clients
42+
appName: "MongoDB Shell"
43+
command: insert {
44+
insert: "###", documents: [ {
45+
_id: "###", name: "###", PII: "###"
46+
} ],
47+
ordered: "###"
48+
}
49+
50+
Use :parameter:`redactClientLogData` in conjunction with
51+
:ref:`security-encryption-at-rest` and :ref:`transport-encryption` to assist
52+
compliance with regulatory requirements.

source/reference/log-messages.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -475,3 +475,10 @@ parent. For example, the following sets the
475475
.. [#slow-oplogs]
476476

477477
.. include:: /includes/extracts/4.2-changes-slow-oplog-log-message-footnote.rst
478+
479+
.. _log-message-log-redaction:
480+
481+
Log Redaction
482+
-------------
483+
484+
.. include:: /includes/fact-log-redaction.rst

source/security.txt

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,11 @@ security features include:
5252

5353
:doc:`/core/auditing`
5454

55+
:ref:`log-message-log-redaction`
56+
5557
- :doc:`/core/security-client-side-encryption`
56-
57-
-
58+
59+
-
5860

5961
Security Checklist
6062
------------------

0 commit comments

Comments
 (0)