Skip to content

Commit 125d52e

Browse files
authored
DOCSP-26288 replaces auditing-related doc directives (#2102)
* DOCSP-26288 replaces auditing-realted doc directives * internal review feedback * internal review feedback
1 parent e879204 commit 125d52e

15 files changed

+38
-36
lines changed

source/core/transactions-production-consideration.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ Transactions and Security
140140
have :doc:`privileges </reference/built-in-roles>` for the
141141
:ref:`operations in the transaction <transactions-operations>`.
142142

143-
- If running with :doc:`auditing </core/auditing>`, operations in an
143+
- If running with :ref:`auditing <auditing>`, operations in an
144144
aborted transaction are still audited. However, there is no audit
145145
event that indicates that the transaction aborted.
146146

source/includes/steps-log-rotate-rename.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ action:
3232
code: |
3333
db.adminCommand( { logRotate : "server" } )
3434
post: |
35-
If :doc:`auditing </core/auditing>` is enabled, you can specify ``1``
35+
If :ref:`auditing <auditing>` is enabled, you can specify ``1``
3636
to ``logRotate`` (instead of ``server``) to rotate both the server
3737
and audit logs at the same time, if desired. The audit log will be
3838
rotated in the same fashion as the server log, according to the

source/reference/command/abortTransaction.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,6 @@ transaction ends.
6060
Security
6161
~~~~~~~~
6262

63-
If running with :doc:`auditing </core/auditing>`, operations in an
63+
If running with :ref:`auditing <auditing>`, operations in an
6464
aborted transaction are still audited.
6565

source/reference/command/getAuditConfig.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The command has the following syntax:
3737
Behavior
3838
--------
3939

40-
:doc:`Auditing </core/auditing>` must be enabled in order to use
40+
:ref:`Auditing <auditing>` must be enabled to use
4141
:dbcommand:`getAuditConfig`.
4242

4343
Nodes that are not participating in a runtime audit configuration
@@ -53,8 +53,8 @@ quickly. However, the distribution mechanism is different on
5353
:parameter:`poll <auditConfigPollingFrequencySecs>` the primary server
5454
at regular intervals for configuration updates. You may see stale data
5555
due to polling delay if you run :dbcommand:`setAuditConfig` on the
56-
primary server and :dbcommand:`getAuditConfig` on a
57-
:doc:`shard </sharding>` before the shard has polled the primary server
56+
primary server and :dbcommand:`getAuditConfig` on a :ref:`shard
57+
<sharding-introduction>` before the shard has polled the primary server
5858
for updated configuration details.
5959

6060
.. note::

source/reference/command/logRotate.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,8 +79,7 @@ Limitations
7979
:option:`--logpath [file] <mongod --logpath>` option in order to use
8080
:dbcommand:`logRotate`
8181

82-
- :doc:`Auditing </core/auditing>` must be enabled in order to rotate
83-
the audit log.
82+
- :ref:`Auditing <auditing>` must be enabled to rotate the audit log.
8483

8584
Behavior
8685
--------

source/reference/command/rotateCertificates.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Logging
147147
On successful rotation, the subject names, thumbprints, and the
148148
validity period of the server and cluster certificate thumbprints are
149149
logged to the configured :ref:`log destination
150-
<log-message-destinations>`. If :doc:`auditing </core/auditing>` is
150+
<log-message-destinations>`. If :ref:`auditing <auditing>` is
151151
enabled, this information is also written to the audit log.
152152

153153
On Linux and Windows platforms, if a :setting:`CRL file

source/reference/command/setAuditConfig.txt

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ The command has the following fields:
5959

6060
* - ``filter``
6161
- document
62-
- An :doc:`audit filter </tutorial/configure-audit-filters>`
62+
- An :ref:`audit filter <audit-filter>`
6363

6464
* - ``auditAuthorizationSuccess``
6565
- boolean
@@ -69,16 +69,16 @@ The command has the following fields:
6969
Behavior
7070
--------
7171

72-
Enable :doc:`Auditing </core/auditing>` to use
72+
Enable :ref:`auditing <auditing>` to use
7373
:dbcommand:`setAuditConfig` at runtime.
7474

75-
:parameter:`auditAuthorizationSuccess` enables :doc:`auditing
76-
</core/auditing>` of authorization success for the :ref:`authCheck
75+
:parameter:`auditAuthorizationSuccess` enables auditing of
76+
authorization success for the :ref:`authCheck
7777
<audit-action-details-results>` action. The parameter value must be
7878
``true`` to audit read and write operations. However, when
7979
:parameter:`auditAuthorizationSuccess` is ``false`` auditing has less
80-
performance impact because the :doc:`audit system </core/auditing>` only
81-
logs authorization failures.
80+
performance impact because the audit system only logs authorization
81+
failures.
8282

8383
Configuration updates are distributed via the :term:`oplog` mechanism
8484
which means updates on :binary:`~bin.mongod` nodes are distributed to
@@ -88,8 +88,8 @@ have to :parameter:`poll <auditConfigPollingFrequencySecs>` the primary
8888
server at regular intervals for configuration updates. You may see
8989
stale data due to polling delay if you run :dbcommand:`setAuditConfig`
9090
on the primary server and :dbcommand:`getAuditConfig` on a
91-
:doc:`shard </sharding>` before the shard has polled the primary server
92-
for updated configuration details.
91+
:ref:`shard <sharding-introduction>` before the shard has polled the
92+
primary server for updated configuration details.
9393

9494
Examples
9595
--------
@@ -211,6 +211,7 @@ Search the ``inventory`` collection in the ``sales`` database using the
211211

212212
.. seealso::
213213

214-
:method:`db.adminCommand`, :dbcommand:`getAuditConfig`,
215-
:doc:`configure audit filters</tutorial/configure-audit-filters>`
214+
- :method:`db.adminCommand`
215+
- :dbcommand:`getAuditConfig`
216+
- :ref:`configure audit filters <audit-filter>`
216217

source/reference/configuration-options.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4509,7 +4509,7 @@ LDAP Parameters
45094509

45104510
*Type*: string
45114511

4512-
When set, :setting:`auditLog.destination` enables :doc:`auditing </core/auditing>` and
4512+
When set, :setting:`auditLog.destination` enables :ref:`auditing <auditing>` and
45134513
specifies where :binary:`~bin.mongos` or :binary:`~bin.mongod` sends all audit events.
45144514

45154515
:setting:`auditLog.destination` can have one of the following values:
@@ -4612,7 +4612,7 @@ LDAP Parameters
46124612

46134613
*Type*: string
46144614

4615-
The output file for :doc:`auditing </core/auditing>` if
4615+
The output file for :ref:`auditing <auditing>` if
46164616
:setting:`~auditLog.destination` has value of ``file``. The :setting:`auditLog.path`
46174617
option can take either a full path name or a relative path name.
46184618

source/reference/method/Session.abortTransaction.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ transaction ends.
4747
Security
4848
~~~~~~~~
4949

50-
If running with :doc:`auditing </core/auditing>`, operations in an
50+
If running with :ref:`auditing <auditing>`, operations in an
5151
aborted transaction are still audited.
5252

5353
Retryable

source/reference/method/db.rotateCertificates.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ Logging
145145
On successful rotation, the subject names, thumbprints, and the
146146
validity period of the server and cluster certificate thumbprints are
147147
logged to the configured :ref:`log destination
148-
<log-message-destinations>`. If :doc:`auditing </core/auditing>` is
148+
<log-message-destinations>`. If :ref:`auditing <auditing>` is
149149
enabled, this information is also written to the audit log.
150150

151151
On Linux and Windows platforms, if a :setting:`CRL file

source/reference/parameters.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4662,12 +4662,12 @@ Auditing Parameters
46624662

46634663
|both|
46644664

4665-
Enables the :doc:`auditing </core/auditing>` of authorization
4665+
Enables the :ref:`auditing <auditing>` of authorization
46664666
successes for the :ref:`authCheck <audit-action-details-results>`
46674667
action.
46684668

46694669
When :parameter:`auditAuthorizationSuccess` is ``false``, the
4670-
:doc:`audit system </core/auditing>` only logs the authorization
4670+
:ref:`audit system <auditing>` only logs the authorization
46714671
failures for ``authCheck``.
46724672

46734673
To enable the audit of authorization successes, issue the following
@@ -4722,7 +4722,7 @@ Auditing Parameters
47224722
log encryption <security-encryption-at-rest-audit-log>`. A header is
47234723
placed at the top of each audit log file and contains metadata for
47244724
decrypting the audit log. The headers are also stored in the
4725-
:doc:`audit log </core/auditing>`.
4725+
:ref:`audit log <auditing>`.
47264726

47274727
You can only set :parameter:`auditEncryptionHeaderMetadataFile`
47284728
during startup in the :setting:`configuration file <setParameter>` or

source/reference/program/mongod.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2920,7 +2920,7 @@ Audit Options
29202920
.. option:: --auditDestination
29212921

29222922

2923-
Enables :doc:`auditing </core/auditing>` and specifies where
2923+
Enables :ref:`auditing <auditing>` and specifies where
29242924
:program:`mongod` sends all audit events.
29252925

29262926
:option:`--auditDestination` can have one of the following values:
@@ -2998,9 +2998,10 @@ Audit Options
29982998

29992999
.. option:: --auditPath
30003000

3001-
Specifies the output file for :doc:`auditing </core/auditing>` if
3002-
:option:`--auditDestination` has value of ``file``. The :option:`--auditPath`
3003-
option can take either a full path name or a relative path name.
3001+
Specifies the output file for auditing if
3002+
:option:`--auditDestination` has value of ``file``. The
3003+
:option:`--auditPath` option can take either a full path name or a
3004+
relative path name.
30043005

30053006
.. include:: /includes/note-audit-in-enterprise-only.rst
30063007

source/reference/program/mongos.txt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1525,7 +1525,7 @@ Audit Options
15251525
.. option:: --auditDestination
15261526

15271527

1528-
Enables :doc:`auditing </core/auditing>` and specifies where
1528+
Enables :ref:`auditing <auditing>` and specifies where
15291529
:program:`mongos` sends all audit events.
15301530

15311531
:option:`--auditDestination` can have one of the following values:
@@ -1603,9 +1603,10 @@ Audit Options
16031603

16041604
.. option:: --auditPath
16051605

1606-
Specifies the output file for :doc:`auditing </core/auditing>` if
1607-
:option:`--auditDestination` has value of ``file``. The :option:`--auditPath`
1608-
option can take either a full path name or a relative path name.
1606+
Specifies the output file for auditing if
1607+
:option:`--auditDestination` has value of ``file``. The
1608+
:option:`--auditPath` option can take either a full path name or a
1609+
relative path name.
16091610

16101611
.. include:: /includes/note-audit-in-enterprise-only.rst
16111612

source/release-notes/2.6.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -607,7 +607,7 @@ MongoDB Enterprise for Windows includes OpenSSL version 1.0.1g.
607607
Auditing
608608
~~~~~~~~
609609

610-
MongoDB Enterprise adds :doc:`auditing </core/auditing>` capability for
610+
MongoDB Enterprise adds :ref:`auditing <auditing>` capability for
611611
:binary:`~bin.mongod` and :binary:`~bin.mongos` instances. See :ref:`auditing`
612612
for details.
613613

source/release-notes/5.0.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1122,7 +1122,7 @@ Log Changes to Database Profiler Settings
11221122
Independent Log Rotation for Server and Audit Logs
11231123
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
11241124

1125-
Starting in MongoDB 5.0, when :doc:`auditing </core/auditing>` is
1125+
Starting in MongoDB 5.0, when :ref:`auditing <auditing>` is
11261126
enabled, you may now rotate the server and audit logs
11271127
independently using the :dbcommand:`logRotate` command.
11281128
Previously, :dbcommand:`logRotate` would rotate the two logs together.

0 commit comments

Comments
 (0)