[DOCS-13051] Investigate changes in SERVER-29794: Adding a comment to all commands Created: 24/Sep/19  Updated: 13/Nov/23  Resolved: 23/Jun/20

Status: Closed
Project: Documentation
Component/s: manual, Server
Affects Version/s: None
Fix Version/s: 4.3.1, Server_Docs_20231030, Server_Docs_20231106, Server_Docs_20231105, Server_Docs_20231113

Type: Task Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: Steve Renaker (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Documented
documents SERVER-29794 Adding a comment to all commands Closed
Participants:
Days since reply: 3 years, 33 weeks, 1 day ago
Epic Link: DOCS: 4.4 Server Release Work
Story Points: 5

 Description   

Description

Downstream Change Summary

This change allows users to specific 'comment' field. The 'comment' has to be a top level field and can be of any type. The 'comment' field will be visible in profiler, logs and $currentOp for that command.

Note that some commands (like find, aggregate) previously supported 'comment' field. But they could only be a string. With this change, the comment can be any valid BSON object. This will require changing the existing docs and possibly the drivers.

Description of Linked Ticket

The following proposed feature request would allow comments to be added to bulk operations. The comment should behave similar to cursor.comment().

The requested functionality is as follows:

  • Allow a configurable comment be added to bulk.execute() commands.
  • When using a sharded collection if the bulk operation is directed at more than one shard the same comment should appear for the bulk operation across all shards.
  • If a more verbose log level is enabled that shows the individual operation for the bulk operation the same comment should be present on these individual operations.
  • The comment should appear in the mongod logs, system.profile and db.currentOp().

Scope of changes

Impact to Other Docs

MVP (Work and Date)

Resources (Scope or Design Docs, Invision, etc.)



 Comments   
Comment by Githook User [ 23/Jun/20 ]

Author:

{'name': 'Steve Renaker', 'email': 'steve.renaker@10gen.com', 'username': 'steveren'}

Message: DOCS-13051: comment option for all dbcommands
Branch: master
https://github.com/mongodb/docs/commit/3c7d51f678b0e0f6b09f10cd410030600c659f04

Comment by Steve Renaker (Inactive) [ 22/Jun/20 ]

arun.banala the CR for this docs item is ready for tech review whenever you have a moment, thanks!

https://mongodbcr.appspot.com/610730001/

Generated at Thu Feb 08 08:06:49 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.