[DRIVERS-1677] Easier debugging with standardized logging: logging specification Created: 23/Apr/20  Updated: 21/Sep/23

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

Type: New Feature Priority: Major - P3
Reporter: Backlog - Core Eng Program Management Team Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Issue split
split to CDRIVER-4485 Easier debugging with standardized lo... Backlog
split to CXX-2586 Easier debugging with standardized lo... Backlog
split to RUBY-3144 Easier debugging with standardized lo... Backlog
split to PHPLIB-998 Easier debugging with standardized lo... Blocked
split to PYTHON-3457 Easier debugging with standardized lo... In Code Review
split to CSHARP-4345 Easier debugging with standardized lo... Closed
split to GODRIVER-2570 Easier debugging with standardized lo... Closed
split to JAVA-4752 Easier debugging with standardized lo... Closed
split to MOTOR-1037 Easier debugging with standardized lo... Closed
split to NODE-4685 Easier debugging with standardized lo... Closed
split to RUST-580 Easier Debugging with Standardized Lo... Closed
Related
related to DRIVERS-2573 Add invalid, valid-pass and valid-fai... Backlog
Epic Link: Easier debugging with standardized logging
Driver Changes: Needed
Quarter: FY23Q3, FY23Q4, FY24Q1
Downstream Changes Summary:

I suggest that drivers do their implementation of this ticket in tandem with their implementation of DRIVERS-1673 which adds command log messages. This way the driver will have actual log messages to emit and test and can confirm that their logging implementation and test code works as expected.

The logging spec can be found here.

The unified test format changes can be found here. To summarize:

  • Client entities may now have a new observeLogMessages property specifying logging configuration for the client
  • Tests may now have a new expectLogMessages property specifying expected log messages to be produced during the test
  • Two new special matching operators $$matchAsRoot and $$matchAsDocument have been added to enable logging assertions.
     
Start date:
Driver Compliance:
Key Status/Resolution FixVersion
CDRIVER-4485 Backlog
CXX-2586 Backlog
CSHARP-4345 Done 2.19.0
GODRIVER-2570 Fixed 1.12.0
JAVA-4752 Fixed 4.9.0
NODE-4685 Fixed 5.2.0
MOTOR-1037 Duplicate
PYTHON-3457 In Code Review
PHPLIB-998 Blocked
RUBY-3144 Backlog
SWIFT-1643 Won't Do
RUST-580 Fixed 2.4.0

 Description   

See DRIVERS-1204 for details on this project overall.

This ticket tracks the logging spec (which defines no log messages, just requirements around logging in general) and its corresponding unified test format changes.

There are individual tickets in DRIVERS-1204 which track adding log messages to individual specifications.



 Comments   
Comment by Githook User [ 14/Oct/22 ]

Author:

{'name': 'Kaitlin Mahar', 'email': 'kaitlin.mahar@mongodb.com', 'username': 'kmahar'}

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

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