Skip to content

Commit aa7a1a6

Browse files
authored
DOCS-15890 Add Log Redaction to Log Messages + Security Page (#2737) (#2834)
* DOCS-15890 Add Log Redaction to Log Messages + Security Page * DC feedback
1 parent b1d8b0f commit aa7a1a6

File tree

4 files changed

+62
-52
lines changed

4 files changed

+62
-52
lines changed

source/administration/monitoring.txt

Lines changed: 1 addition & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -313,58 +313,7 @@ affect logging:
313313
Log Redaction
314314
~~~~~~~~~~~~~
315315

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

369318
Diagnosing Performance Issues
370319
-----------------------------
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
@@ -1044,6 +1044,13 @@ to complete. Specifically:
10441044
merge. For example, ``durationMillis`` of 100 and
10451045
``remoteOpWaitMillis`` of 15.
10461046

1047+
.. _log-message-log-redaction:
1048+
1049+
Log Redaction
1050+
-------------
1051+
1052+
.. include:: /includes/fact-log-redaction.rst
1053+
10471054
.. _log-message-parsing:
10481055

10491056
Parsing Structured Log Messages

source/security.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ security features include:
5151

5252
:doc:`/core/auditing`
5353

54+
:ref:`log-message-log-redaction`
55+
5456
- :ref:`qe-manual-feature-qe`
5557

5658
:ref:`manual-csfle-feature`

0 commit comments

Comments
 (0)