[DRIVERS-1673] Add log messages to Command monitoring spec Created: 05/Aug/20  Updated: 21/Sep/23

Status: Implementing
Project: Drivers
Component/s: Command Logging and Monitoring
Fix Version/s: None

Type: New Feature Priority: Major - P3
Reporter: Esha Bhargava Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Depends
Issue split
split to CDRIVER-4486 Add log messages to Command monitorin... Backlog
split to CXX-2587 Add log messages to Command monitorin... Backlog
split to PHPC-2237 Add logging to command monitoring Backlog
split to RUBY-3145 Add log messages to Command monitorin... Backlog
split to PHPLIB-999 Add log messages to Command monitorin... Blocked
split to PYTHON-3458 Add log messages to Command monitorin... In Code Review
split to CSHARP-4346 Add log messages to Command monitorin... Closed
split to GODRIVER-2571 Add log messages to Command monitorin... Closed
split to JAVA-4753 Add log messages to Command monitorin... Closed
split to MOTOR-1038 Add log messages to Command monitorin... Closed
split to NODE-4686 Add log messages to Command monitorin... Closed
split to RUST-1494 Add log messages to Command monitorin... Closed
Epic Link: Easier debugging with standardized logging
Driver Changes: Needed
Quarter: FY23Q3, FY23Q4, FY24Q1
Downstream Changes Summary:

This ticket depends on the driver having implemented the changes from DRIVERS-1677. It is suggested that drivers do this ticket in tandem with DRIVERS-1677 so that they have a first set of log messages and tests to try out with their logging implementation and unified test runner changes.

Log messages and corresponding tests for command logging were added via this commit.

In summary, drivers will need to:

  • Implement the log messages defined here
  • Run the unified format tests defined here
  • Implement the prose tests defined here

Also, note that the spec was renamed "Command Logging and Monitoring" (we'll see if the acronym CLAM catches on!) and that the spec directory/RST file were renamed to command-logging-and-monitoring, so any scripts that rely on the name to e.g. sync tests will need to be updated.

Start date:
Driver Compliance:
Key Status/Resolution FixVersion
CDRIVER-4486 Backlog
CXX-2587 Backlog
CSHARP-4346 Done 2.19.0
GODRIVER-2571 Duplicate
JAVA-4753 Fixed 4.9.0
NODE-4686 Fixed 6.4.0
MOTOR-1038 Duplicate
PYTHON-3458 In Code Review
PHPLIB-999 Blocked
RUBY-3145 Backlog
RUST-1494 Fixed 2.4.0
SWIFT-1644 Won't Do
PHPC-2237 Backlog

 Description   

Add log messages to the command monitoring (now command logging and monitoring, or CLAM) spec, and add corresponding tests.



 Comments   
Comment by Jeremy Mikola [ 21/Sep/23 ]

Copying over a Githook message, which was incorrectly attributed to DRIVERS-1633:

Author:

Unknown macro: {'name'}

Message: DRIVERS-1677, DRIVERS-1633: Add logging specification and command logging (#1303)

Comment by Githook User [ 11/Nov/22 ]

Author:

{'name': 'Preston Vasquez', 'email': '24281431+prestonvasquez@users.noreply.github.com', 'username': 'prestonvasquez'}

Message: DRIVERS-1673 Minor typo fixes (#1338)

Co-authored-by: Kaitlin Mahar <kaitlinmahar@gmail.com>

Co-authored-by: Kaitlin Mahar <kaitlinmahar@gmail.com>

Co-authored-by: Kaitlin Mahar <kaitlinmahar@gmail.com>

Co-authored-by: Kaitlin Mahar <kaitlinmahar@gmail.com>

Co-authored-by: Kaitlin Mahar <kaitlinmahar@gmail.com>

Co-authored-by: Kaitlin Mahar <kaitlinmahar@gmail.com>

Co-authored-by: Kaitlin Mahar <kaitlinmahar@gmail.com>

Co-authored-by: Kaitlin Mahar <kaitlinmahar@gmail.com>
Branch: master
https://github.com/mongodb/specifications/commit/77f9f665a8705d0bd26aebc1fc542583ac61f944

Comment by Kaitlin Mahar [ 29/Sep/20 ]

adding DRIVERS-1207 as a dependency since we would like to log serverConnectionId as well

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