Uploaded image for project: 'Go Driver'
  1. Go Driver
  2. GODRIVER-1712

Easier debugging with standardized logging

    • Type: Icon: Epic Epic
    • Resolution: Fixed
    • Priority: Icon: Major - P3 Major - P3
    • 1.13.0, 1.13.1
    • Affects Version/s: None
    • Component/s: None
    • None
    • Completed
    • Hide
      1. What would you like to communicate to the user about this feature?
      2. Would you like the user to see examples of the syntax and/or executable code and its output?
      3. Which versions of the driver/connector does this apply to?
      Show
      1. What would you like to communicate to the user about this feature? 2. Would you like the user to see examples of the syntax and/or executable code and its output? 3. Which versions of the driver/connector does this apply to?
    • Done
    • Easier debugging with standardized logging
    • 7
    • 13
    • 13
    • 100
    • Hide

      Engineer(s): Preston

      Summary: Define a default set of debug logging messages that drivers should produce, and a standardized, trivial mechanism drivers should support for enabling, disabling, and configuring debug logging.

      2023-08-04: Updating target end date to 2023-08-11

      Status Update:

      • Final PR is pending one additional reviewer, should wrap up early next week

      2023-07-21: Updating target end date to 2023-07-28

      Status Update:

      • All the dev work is complete. Waiting for reviews to wrap up
      • Added additional time for reviews and to incorporate review feedback

      2023-07-07: No change to target end date

      • Adding logs to the SDAM spec in review
      • Adding logs to the server selection spec is up next

      2023-06-23: Updated target end date to 2023-07-14

      Status Update:

      • Pre-work for adding logs to the server selection spec close to wrapping up
      • Started on the second implementation for adding logs to the SDAM spec. Boris and Preston are discussing issues with the implementation that might affect other driver teams
      • Adding logs to the server selection spec is up next
      • Added two more weeks to the end date; one to account for reviews and another for server selection

      2023-06-08: 

      Status Update:

      • Pre-work for adding logs to the server selection spec was picked up last week. This is taking longer than expected in Go because we need to update the Go Driver usages of SessionTimeoutMinutes to ensure that logicalSessionTimeoutMinutes=0 no longer means that a connection does not support sessions 
      • Adding logs to the server selection spec is up next
      • Note that we put this on hold on 2/24/23 and picked this back up last week so please ignore the previous end date

      2023-02-17: Updating end date to 2023-02-24

      Status Update:

      • Wrapping up the review for adding logs to the CMAP spec. This is the last piece of work that can be completed before the remaining spec work is merged
      • Added another week to the end date for review wrap up

      2023-02-03: Updating end date to 2023-02-17

      Status Update:

      • Logging PR and design wrapped up
      • Working on adding logs to CMAP which is taking longer than expected
      • Misc. updates to the logging spec is next up

      2023-01-19: Updating end date to 2023-02-03

      Status update:

      • Logging PR in review.
      • Working on adding logs to CMAP.

      Rationale for delays:

      • Logging PR is taking longer than expected due to discussions about async vs sync logging.

      2023-01-05: Updating end date to 2023-01-20

      Status update:

      • Prototype in review.

      Rationale for delays:

      • Underestimated. Holidays.

      2022-12-08: No change to target date.

      Status update:

      • Proceeding with implementation.

      2022-11-21: No change to target date.

      Status update:

      • Technical design in review and has been discussed.
      • Proceeding with implementation.

      2022-11-10: Setting end date to 01-06-2023

      Status update:

      • Technical design in review.

      Rationale for delays:

      • No delays.

      Risks:

      • No risks.

      Show
      Engineer(s): Preston Summary: Define a default set of debug logging messages that drivers should produce, and a standardized, trivial mechanism drivers should support for enabling, disabling, and configuring debug logging. 2023-08-04: Updating target end date to 2023-08-11 Status Update: Final PR is pending one additional reviewer, should wrap up early next week 2023-07-21: Updating target end date to 2023-07-28 Status Update: All the dev work is complete. Waiting for reviews to wrap up Added additional time for reviews and to incorporate review feedback 2023-07-07: No change to target end date Adding logs to the SDAM spec in review Adding logs to the server selection spec is up next 2023-06-23: Updated target end date to 2023-07-14 Status Update: Pre-work for adding logs to the server selection spec close to wrapping up Started on the second implementation for adding logs to the SDAM spec. Boris and Preston are discussing issues with the implementation that might affect other driver teams Adding logs to the server selection spec is up next Added two more weeks to the end date; one to account for reviews and another for server selection 2023-06-08:  Status Update: Pre-work for adding logs to the server selection spec was picked up last week. This is taking longer than expected in Go because we need to update the Go Driver usages of SessionTimeoutMinutes to ensure that logicalSessionTimeoutMinutes=0 no longer means that a connection does not support sessions  Adding logs to the server selection spec is up next Note that we put this on hold on 2/24/23 and picked this back up last week so please ignore the previous end date 2023-02-17: Updating end date to 2023-02-24 Status Update: Wrapping up the review for adding logs to the CMAP spec. This is the last piece of work that can be completed before the remaining spec work is merged Added another week to the end date for review wrap up 2023-02-03: Updating end date to 2023-02-17 Status Update: Logging PR and design wrapped up Working on adding logs to CMAP which is taking longer than expected Misc. updates to the logging spec is next up 2023-01-19: Updating end date to 2023-02-03 Status update: Logging PR in review. Working on adding logs to CMAP. Rationale for delays: Logging PR is taking longer than expected due to discussions about async vs sync logging. 2023-01-05: Updating end date to 2023-01-20 Status update: Prototype in review. Rationale for delays: Underestimated. Holidays. 2022-12-08: No change to target date. Status update: Proceeding with implementation. 2022-11-21: No change to target date. Status update: Technical design in review and has been discussed. Proceeding with implementation. 2022-11-10: Setting end date to 01-06-2023 Status update: Technical design in review. Rationale for delays: No delays. Risks: No risks.
    • Hide

      DRIVERS-1204:

      • Implement logging infrastructure and unified test runners defined in DRIVERS-1677
      • Implement log messages and corresponding tests for each component
      Show
      DRIVERS-1204 : Implement logging infrastructure and unified test runners defined in DRIVERS-1677 Implement log messages and corresponding tests for each component

          Assignee:
          preston.vasquez@mongodb.com Preston Vasquez
          Reporter:
          esha.bhargava@mongodb.com Esha Bhargava
          Votes:
          0 Vote for this issue
          Watchers:
          4 Start watching this issue

            Created:
            Updated:
            Resolved:
            36 weeks, 1 day