Skip to content

Fixes #2087

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

Fixes #2087

Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 9 additions & 11 deletions source/core/auditing.txt
Original file line number Diff line number Diff line change
Expand Up @@ -13,29 +13,27 @@ MongoDB Enterprise includes an auditing capability for
facility allows administrators and users to track system activity for
deployments with multiple users and applications. The auditing facility
can write audit events to the console, the :term:`syslog`, a JSON file,
or a BSON file. For details on the audit log messages, see
:doc:`/reference/audit-message`.
or a BSON file.

Audit Events and Filter
-----------------------

The auditing system can record the following operations:
To enable auditing for MongoDB Enterprise, see
:doc:`/tutorial/configure-auditing`.

Once enabled, the auditing system can record the following operations:

- schema (DDL),
- replica set,
- authentication and authorization, and
- general operations.

See :ref:`audit-action-details-results` for the specific actions
recorded.
For details on the audit log messages, see
:doc:`/reference/audit-message`.

By default, the auditing system records all these operations; however,
you can configure the :option:`--auditFilter` option to restrict the
events captured.

See :doc:`/tutorial/configure-auditing` to enable and configure
auditing for MongoDB Enterprise. To set up filters, see
:ref:`audit-filter`.
you can :ref:`set up filters <audit-filter>` to restrict the events
captured. To set up filters, see :ref:`audit-filter`.

Audit Guarantee
---------------
Expand Down
2 changes: 2 additions & 0 deletions source/includes/fact-audit-filter-single-quotes.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
To specify an audit filter, enclose the filter document in single
quotes to pass the document as a string.
3 changes: 3 additions & 0 deletions source/includes/fact-audit-filter-yaml-configuration.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
To specify the audit filter in a :doc:`configuration file
</reference/configuration-options>`, you must use the YAML format of
the configuration file.
2 changes: 1 addition & 1 deletion source/includes/note-fips-is-enterprise-only.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. note:: FIPS Compatible SSL is
available only in `MongoDB Enterprise
<http://www.mongodb.com/products/mongodb-enterprise>`_. See
:docs:`/tutorial/configure-fips` for more information.
:doc:`/tutorial/configure-fips` for more information.
17 changes: 12 additions & 5 deletions source/includes/options-mongod.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1451,15 +1451,22 @@ description: |

.. code-block:: javascript

{ atype: <expression> }
{ <field1>: <expression1>, ... }

For authentication operations, the option can also take a document of
the form:
The ``<field>`` can be :doc:`any field in the audit message
</reference/audit-message>`, including fields returned in the
:ref:`param <audit-action-details-results>` document. The
``<expression>`` is a :ref:`query condition expression
<query-selectors>`.

.. code-block:: javascript
.. include:: /includes/fact-audit-filter-single-quotes.rst

.. include:: /includes/fact-audit-filter-yaml-configuration.rst

{ atype: <expression>, "param.db": <database> }

{ atype: <expression>, "param.db": <database> }
.. include:: /includes/note-audit-in-enterprise-only.rst

optional: true
---
program: mongod
Expand Down
2 changes: 1 addition & 1 deletion source/includes/options-mongorestore.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@ optional: true
---
program: mongorestore
name: numParallelCollections
alias: j
aliases: -j
args: int
directive: option
description: |
Expand Down
2 changes: 1 addition & 1 deletion source/includes/options-mongotop.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -168,7 +168,7 @@ optional: true
---
program: mongotop
name: rowcount
alias: n
aliases: -n
directive: option
args: int
description: |
Expand Down
Loading