Skip to content

Commit

Permalink
DOCS-9090: add redactClientLogData to mongos
Browse files Browse the repository at this point in the history
Made some minor tweaks to the mongod yaml file

Signed-off-by: kay <[email protected]>
  • Loading branch information
ravindk89 authored and kay-kim committed Dec 1, 2016
1 parent 9e65215 commit c60e5ea
Show file tree
Hide file tree
Showing 4 changed files with 29 additions and 11 deletions.
2 changes: 1 addition & 1 deletion source/includes/options-conf.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1762,7 +1762,7 @@ inherit:
program: mongod
file: options-mongod.yaml
replacement:
program: :program:`mongod`
program: ":program:`mongod` or :program:`mongos`"
---
program: conf
name: security.ldap.servers
Expand Down
27 changes: 17 additions & 10 deletions source/includes/options-mongod.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2136,20 +2136,27 @@ description: |
</core/security-encryption>` to assist compliance with regulatory
requirements.
For example, a {{program}} might store Personally Identifiable Information
(PII) in one or more collections. The {{program}} logs events related to CRUD
operations, sharding metadata, or replication information. It is possible
that the {{program}} may expose PII as a part of these logging operations.
A {{program}} running with {{role}} removes any message accompanying
these events before being output to the log, effectively removing the PII.
Diagnostics on a {{mongod}} running with {{role}} may be more difficult
For example, a MongoDB deployment might store Personally Identifiable
Information (PII) in one or more collections. The {{program}} logs events
such as those related to CRUD operations, sharding metadata, etc. It is
possible that the {{program}} may expose PII as a part of these logging
operations. A {{program}} running with {{role}} removes any message
accompanying these events before being output to the log, effectively
removing the PII.
Diagnostics on a {{program}} running with {{role}} may be more difficult
due to the lack of data related to a log event. See the
:ref:`process logging <monitoring-log-redaction>` manual page for an
example of the effect of {{role}} on log output.
You can toggle {{role}} on or off using :dbcommand:`setParameter` during
runtime.
You can enable or disable log redaction on a running {{program}}
using the :dbcommand:`setParameter` database command.
.. code-block:: javascript
db.getSiblingDB("admin").runCommand(
{ setParameter: { redactClientLogData : "true | false" } }
)
---
program: mongod
name: ldapServers
Expand Down
9 changes: 9 additions & 0 deletions source/includes/options-mongos.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -494,4 +494,13 @@ inherit:
name: ldapUserToDNMapping
program: mongod
file: options-mongod.yaml
---
program: mongos
name: redactClientLogData
args: null
directive: option
inherit:
name: redactClientLogData
program: mongod
file: options-mongod.yaml
...
2 changes: 2 additions & 0 deletions source/reference/program/mongos.txt
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ Core Options

.. include:: /includes/option/option-mongos-logappend.rst

.. include:: /includes/option/option-mongos-redactClientLogData.rst

.. include:: /includes/option/option-mongos-timeStampFormat.rst

.. include:: /includes/option/option-mongos-pidfilepath.rst
Expand Down

0 comments on commit c60e5ea

Please sign in to comment.