Uploaded image for project: 'Drivers'
  1. Drivers
  2. DRIVERS-1204

Easier debugging with standardized logging

    XMLWordPrintable

Details

    • Epic
    • Status: Designing
    • Major - P3
    • Resolution: Unresolved
    • Logging
    • None
    • Needed
    • 8
    • 4
    • 8
    • Hide

      Engineer: Kaitlin Mahar
      Summary: The goal of this project is to 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.

       2022-06-14:

      • Drafted some command logging tests; got corresponding test runner changes implemented and tests passing in Rust. TBD if proposed tests will be feasible for drivers doing unstructured logging - will determine this via a Java POC
      • Next going to try implementing log messages for a couple more specs (SDAM, CMAP) to see if there are any considerations we've missed with command messages.

      2022-06-10: Have made a small amount of progress on drafting tests and Rust test runner changes needed to run them. Not incrementing cost as only 1-2 days were spent on this

      2022-05-27: Converted command monitoring tests to the unified format. Started on logging assertions to tests.

      2022-05-12: Initial implementation of command logging in RUST is almost complete, shifting focused to testing.

      2022-04-22: Project was on hold as Kaitlin was focused on other priority tasks.

      2022-04-19: Kaitlin is working on a first implementation of the spec and logging command messages in Rust.

      2022-04-01: Kaitlin resuming this project with a future implementation in RUST.

      Lead: Jeff Yemin
      Author: Kaitlin Mahar

      2021-01-12:

      • On Pause. We’ll revisit priority in our QP prep meeting on 1/15

      2020-12-22:

      • No new updates. Kaitlin OOO from 12/21 - 1/3.

      2020-12-15:

      • Still on pause. Kaitlin spent the last few weeks wrapping up the work for unified test runner in Swift, working on a design for Nataly’s rotation project, and getting ramped up on Node.
      • She’ll be OOO from 12/21 - 01/3 and will pick this up after coming back.
      Show
      Engineer: Kaitlin Mahar Summary: The goal of this project is to 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.  2022-06-14: Drafted some command logging tests; got corresponding test runner changes implemented and tests passing in Rust. TBD if proposed tests will be feasible for drivers doing unstructured logging - will determine this via a Java POC Next going to try implementing log messages for a couple more specs (SDAM, CMAP) to see if there are any considerations we've missed with command messages. 2022-06-10: Have made a small amount of progress on drafting tests and Rust test runner changes needed to run them. Not incrementing cost as only 1-2 days were spent on this 2022-05-27: Converted command monitoring tests to the unified format. Started on logging assertions to tests. 2022-05-12: Initial implementation of command logging in RUST is almost complete, shifting focused to testing. 2022-04-22: Project was on hold as Kaitlin was focused on other priority tasks. 2022-04-19: Kaitlin is working on a first implementation of the spec and logging command messages in Rust. 2022-04-01: Kaitlin resuming this project with a future implementation in RUST. Lead: Jeff Yemin Author: Kaitlin Mahar 2021-01-12: On Pause. We’ll revisit priority in our QP prep meeting on 1/15 2020-12-22: No new updates. Kaitlin OOO from 12/21 - 1/3. 2020-12-15: Still on pause. Kaitlin spent the last few weeks wrapping up the work for unified test runner in Swift, working on a design for Nataly’s rotation project, and getting ramped up on Node. She’ll be OOO from 12/21 - 01/3 and will pick this up after coming back.

    Description

      Epic Summary

      Summary

      A common complaint from our support team is that they don't know how to get debugging information out of drivers. Some drivers provide debug logging for this purpose, others do not. For drivers that do provide it, the log messages produced and the mechanisms for enabling debug logging are not consistent.

      The goal of this project is to 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. This will provide TSEs, CEs and users an easy way to get debugging information out of our drivers. Each driver should additionally provide easily discoverable documentation on how to enable logging and what features are provided.

      The key idea here is to provide consistency across drivers, making it easier to support all drivers and far easier to document how to debug specific issues.

      Cast of Characters

      Lead: Jeff Yemin
      Author: Kaitlin Mahar
      POCs: Rust - Kaitlin, C# - Boris
      Product Owner: Rachelle Palmer

      Documentation

      Scope Document
      Technical Design Document

      Attachments

        Issue Links

          depends on

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. SWIFT-511 Integrate with SwiftMetrics and SwiftLog

          • Major - P3 - Major loss of function.
          • Backlog

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. CSHARP-2829 Add logging to the driver

          • Major - P3 - Major loss of function.
          • Closed

          New Feature - A new feature of the product, which has yet to be developed. RUST-580 Easier Debugging with Standardized Logging

          • Major - P3 - Major loss of function.
          • Backlog

          Improvement - An improvement or enhancement to an existing feature or task. PYTHON-2076 Provide importable APM event listeners

          • Major - P3 - Major loss of function.
          • Closed
          is depended on by

          Task - A task that needs to be done. TOOLS-2636 Remove logging code in MTC in favor of logging by driver

          • Major - P3 - Major loss of function.
          • Waiting (Blocked)

          Improvement - An improvement or enhancement to an existing feature or task. PHPC-1425 Sanitize URI and certificate passwords in debug logs

          • Major - P3 - Major loss of function.
          • Blocked

          Improvement - An improvement or enhancement to an existing feature or task. CSHARP-3589 Unknown compressor does not log a warning

          • Minor - P4 - Minor loss of function, or other problem where easy workaround is present.
          • Blocked
          is related to

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. GODRIVER-1242 Logging framework

          • Major - P3 - Major loss of function.
          • Closed

          Task - A task that needs to be done. NODE-3503 Fix logger options and reintroduce logging lines

          • Major - P3 - Major loss of function.
          • Backlog
          related to

          Task - A task that needs to be done. JAVA-4486 POC changes needed to implement unified test runner changes

          • Major - P3 - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. CSHARP-3663 Introduce simple logging instrumentation to be used in tests

          • Major - P3 - Major loss of function.
          • Closed

          Improvement - An improvement or enhancement to an existing feature or task. PHPC-1991 Enable logging <various level> in driver

          • Major - P3 - Major loss of function.
          • Closed
          split to

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. CSHARP-4044 Easier debugging with standardized logging

          • Major - P3 - Major loss of function.
          • Blocked

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. CXX-2448 Easier debugging with standardized logging

          • Major - P3 - Major loss of function.
          • Blocked

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. JAVA-4485 Easier debugging with standardized logging

          • Major - P3 - Major loss of function.
          • Blocked

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. MOTOR-888 Easier debugging with standardized logging

          • Major - P3 - Major loss of function.
          • Blocked

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. NODE-3974 Easier debugging with standardized logging

          • Major - P3 - Major loss of function.
          • Blocked

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. PHPC-2061 Easier debugging with standardized logging

          • Major - P3 - Major loss of function.
          • Blocked

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. PYTHON-3113 Easier debugging with standardized logging

          • Major - P3 - Major loss of function.
          • Blocked

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. RUBY-2900 Easier debugging with standardized logging

          • Major - P3 - Major loss of function.
          • Blocked

          Epic - Created by Jira Software - do not edit or delete. Issue type for a big user story that needs to be broken down. RUST-1176 Easier debugging with standardized logging

          • Major - P3 - Major loss of function.
          • Blocked

          Task - A task that needs to be done. CDRIVER-3775 POC: Easier debugging with standardized logging

          • Major - P3 - Major loss of function.
          • Backlog

          Task - A task that needs to be done. GODRIVER-1712 POC: Easier debugging with standardized logging

          • Major - P3 - Major loss of function.
          • Backlog

          Task - A task that needs to be done. SWIFT-991 POC: Easier debugging with standardized logging

          • Major - P3 - Major loss of function.
          • Blocked
          mentioned in

          Page Loading...

          Activity

            People

              kaitlin.mahar@mongodb.com Kaitlin Mahar
              bernie@mongodb.com Bernie Hackett
              Kaitlin Mahar Kaitlin Mahar
              Rachelle Palmer Rachelle Palmer
              Martin Bajana Martin Bajana
              Votes:
              5 Vote for this issue
              Watchers:
              14 Start watching this issue

              Dates

                Created:
                Updated: