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

Easier debugging with standardized logging: logging specification

XMLWordPrintableJSON

    • Type: Icon: New Feature New Feature
    • Resolution: Unresolved
    • Priority: Icon: Major - P3 Major - P3
    • None
    • Component/s: Logging
    • None
    • Needed
    • Hide

      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.
         
      Show
      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.  
    • $i18n.getText("admin.common.words.hide")
      Key Status/Resolution FixVersion
      CDRIVER-4485 In Code Review
      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 Fixed 4.7
      PHPLIB-998 Blocked
      RUBY-3144 Backlog
      SWIFT-1643 Won't Do
      RUST-580 Fixed 2.4.0
      $i18n.getText("admin.common.words.show")
      #scriptField, #scriptField *{ border: 1px solid black; } #scriptField{ border-collapse: collapse; } #scriptField td { text-align: center; /* Center-align text in table cells */ } #scriptField td.key { text-align: left; /* Left-align text in the Key column */ } #scriptField a { text-decoration: none; /* Remove underlines from links */ border: none; /* Remove border from links */ } /* Add green background color to cells with FixVersion */ #scriptField td.hasFixVersion { background-color: #00FF00; /* Green color code */ } /* Center-align the first row headers */ #scriptField th { text-align: center; } Key Status/Resolution FixVersion CDRIVER-4485 In Code Review 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 Fixed 4.7 PHPLIB-998 Blocked RUBY-3144 Backlog SWIFT-1643 Won't Do RUST-580 Fixed 2.4.0

      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.

            Assignee:
            Unassigned Unassigned
            Reporter:
            backlog-server-pm Backlog - Core Eng Program Management Team
            Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

              Created:
              Updated: