Uploaded image for project: 'Node.js Driver'
  1. Node.js Driver
  2. NODE-4686

Add log messages to Command monitoring spec

XMLWordPrintableJSON

    • Type: Icon: New Feature New Feature
    • Resolution: Fixed
    • Priority: Icon: Major - P3 Major - P3
    • 6.4.0
    • Affects Version/s: None
    • Component/s: Logging
    • None
    • 5
    • Hide

      DRIVERS-1673:
      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.

      Show
      DRIVERS-1673 : 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.
    • Not Needed
    • Not Needed
    • 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?

      This ticket was split from DRIVERS-1673, please see that ticket for a detailed description.

      Acceptance Criteria

      Implementation Requirements

      • Implement the logging of the following events from the CLAM spec on component = 'command' and at the debug level 
        • Command Started
        • Command Succeeded
        • Command Failed
      • Ensure that log messages above are appropriately redacted if the commands in question are sensitive
      • If command is handshake, don't log (only add logger to Connection class after connection is established) 
      • Avoid cloning / flag it if needed
      • Ensure this work aligns with ModernConnection/Connection work ongoing in CSOT currently

      Testing Requirements

      • Unskip CLAM spec tests that were skipped in NODE-4685
      • Implement prose tests
        • Test default truncation limit
        • Test explicitly configured truncation limit
        • Language specific truncation limits - investigate further

            Assignee:
            aditi.khare@mongodb.com Aditi Khare
            Reporter:
            dbeng-pm-bot PM Bot
            Durran Jordan
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: