[DOCS-4433] Comment on: "manual/tutorial/configure-auditing.txt" Created: 26/Nov/14  Updated: 18/Dec/14  Resolved: 04/Dec/14

Status: Closed
Project: Documentation
Component/s: manual
Affects Version/s: None
Fix Version/s: v1.3.15

Type: Bug Priority: Major - P3
Reporter: Mark Helmstetter Assignee: Kay Kim (Inactive)
Resolution: Done Votes: 0
Labels: collector-298ba4e7
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment:

Location: http://docs.mongodb.org/manual/tutorial/configure-auditing/
User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_9_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/38.0.2125.111 Safari/537.36
Referrer: http://docs.mongodb.org/manual/core/auditing/
Screen Resolution: 1920 x 1200
repo: docs
source: tutorial/configure-auditing


Issue Links:
Related
is related to DOCS-4308 Comment on: "manual/reference/audit-m... Closed
Participants:
Days since reply: 9 years, 8 weeks, 6 days ago

 Description   

This doc provides examples of configuring auditing using the 2.4 config file format. However, SERVER-12543 states that "auditing options are not available/supported in the old config file format".

Assuming that is correct, the docs should be changed accordingly. The real dangerous and confusing part here is that auditing will work in some cases, and in other cases there may be confusing YAML parsing errors (SERVER-12543).



 Comments   
Comment by Githook User [ 18/Dec/14 ]

Author:

{u'username': u'kay-kim', u'name': u'kay', u'email': u'kay.kim@10gen.com'}

Message: DOCS-4308 DOCS-4433 reverts the reverted auditing changes

Conflicts:
source/includes/options-mongod.yaml
source/reference/audit-message.txt
source/tutorial/configure-auditing.txt

Signed-off-by: kay <kay.kim@10gen.com>
Branch: master
https://github.com/mongodb/docs/commit/f178fcf0560593377642917426cb8a3770ae361f

Comment by Githook User [ 17/Dec/14 ]

Author:

{u'username': u'kay-kim', u'name': u'kay', u'email': u'kay.kim@10gen.com'}

Message: Revert "DOCS-4308 DOCS-4433 auditing changes"

This reverts commit e012824b4a5eb88b814eb204475af61f71b9f716.
Branch: master
https://github.com/mongodb/docs/commit/56e156f63003fd3c71aef8405ce27c0ec86547cb

Comment by Githook User [ 04/Dec/14 ]

Author:

{u'username': u'kay-kim', u'name': u'kay', u'email': u'kay.kim@10gen.com'}

Message: DOCS-4308 DOCS-4433 auditing changes
Branch: master
https://github.com/mongodb/docs/commit/090946b4adaa111196875bb399392b8fce012f6b

Comment by Mark Helmstetter [ 26/Nov/14 ]

I think it should be all or nothing with respect to audit configuration. If auditFilter requires YAML configuration, then all of the auditing examples should explicitly state that requirement and show YAML configuration.

Providing an auditFilter JSON expression in YAML is still tricky. It seems like single quoting the filter value is the safest bet.

Comment by Eric Milkie [ 26/Nov/14 ]

Interestingly, the documentation does not give any examples of using the legacy config file with the auditFilter parameter (which is the only one that technically won't work). We could change the documentation to use the new YAML format for everything, and give an example of auditFilter in a YAML config file as a new addition.

Generated at Thu Feb 08 07:47:59 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.