Skip to content

Commit 98f337c

Browse files
authored
DOCS-15890 Add Log Redaction to Log Messages + Security Page (#2737) (#2836)
* 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 again * build errors AGAIN
1 parent 728a3e7 commit 98f337c

File tree

6 files changed

+66
-53
lines changed

6 files changed

+66
-53
lines changed

source/administration/monitoring.txt

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

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

367316
Diagnosing Performance Issues
368317
-----------------------------

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
@@ -931,6 +931,13 @@ to complete. Specifically:
931931
merge. For example, ``durationMillis`` of 100 and
932932
``remoteOpWaitMillis`` of 15.
933933

934+
.. _log-message-log-redaction:
935+
936+
Log Redaction
937+
-------------
938+
939+
.. include:: /includes/fact-log-redaction.rst
940+
934941
.. _log-message-parsing:
935942

936943
Parsing Structured Log Messages

source/security.txt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,9 @@ security features include:
5151

5252
:doc:`/core/auditing`
5353

54-
- :doc:`/core/security-client-side-encryption`
54+
:ref:`log-message-log-redaction`
5555

56+
- :doc:`/core/security-client-side-encryption`
5657

5758
Security Checklist
5859
------------------

source/tutorial/configure-ssl.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _configure-mongod-mongos-for-tls-ssl:
2+
13
===============================================
24
Configure ``mongod`` and ``mongos`` for TLS/SSL
35
===============================================

0 commit comments

Comments
 (0)