Uploaded image for project: 'C Driver'
  1. C Driver
  2. CDRIVER-3775

Easier debugging with standardized logging

XMLWordPrintableJSON

    • Type: Icon: Epic Epic
    • Resolution: Unresolved
    • Priority: Icon: Major - P3 Major - P3
    • None
    • Affects Version/s: None
    • Component/s: None
    • None
    • 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?
    • To Do
    • Easier debugging with standardized logging
    • 5
    • 8
    • 10
    • 100
    • Hide

      2025-01-03: Updating end date to 2025-01-17

      What was accomplished since the last update?

      • Refactor for JSON serialization in review. Precursor work to avoiding performance drop when logging is enabled (CDRIVER-4814)

      What goals are we targeting for the next two weeks?

      • Merge refactor.
      • Put remaining logging work in review.

      Reasons for delays

      • Initial structured logging PR has been slow to get reviewed due to holidays.

      2024-12-20: Updating end date to 2024-01-10

      (Note: Cost to Date was incorrect before and is intentionally not changed)

      What was accomplished since the last update?

      • Initial structured logging PR approved by one, and awaiting further feedback. Logging to other components is queued.
      • Investigating performance improvements for JSON serialization.

      What goals are we targeting for the next two weeks?

      • Merge initial structured logging PR.

      Reasons for delays

      • Review for initial PR delayed (on-site + holidays), but has not been blocking follow-up work.
      • Improving performance of JSON serialization involves a refactor to avoid repeated buffer creation on recurse.

      2024-12-06: Updating end date to 2024-12-27

      What was accomplished since the last update?

      • Reworked PR to move structured logging handler from global to client/client pool. Awaiting review.
      • Working on adding server selection logging.

      What goals are we targeting for the next two weeks?

      • Add logging to other components (SDAM, server selection)

      Reasons for delays

      • Removed global logging after comparing other language logging implementations.
      • Test runner workarounds needed for single-threaded C driver to pass server selection tests.

      ---- 

      2024-11-22:

      What was accomplished since the last update?

      • Structured logging in review. Passes tests from CLAM spec.

      What goals are we targeting for the next two weeks?

      • Add logging to other components (SDAM, server selection)
      Show
      2025-01-03: Updating end date to 2025-01-17 What was accomplished since the last update? Refactor for JSON serialization in review. Precursor work to avoiding performance drop when logging is enabled ( CDRIVER-4814 ) What goals are we targeting for the next two weeks? Merge refactor. Put remaining logging work in review. Reasons for delays Initial structured logging PR has been slow to get reviewed due to holidays. 2024-12-20: Updating end date to 2024-01-10 (Note: Cost to Date was incorrect before and is intentionally not changed) What was accomplished since the last update? Initial structured logging PR approved by one, and awaiting further feedback. Logging to other components is queued. Investigating performance improvements for JSON serialization. What goals are we targeting for the next two weeks? Merge initial structured logging PR. Reasons for delays Review for initial PR delayed (on-site + holidays), but has not been blocking follow-up work. Improving performance of JSON serialization involves a refactor to avoid repeated buffer creation on recurse. 2024-12-06: Updating end date to 2024-12-27 What was accomplished since the last update? Reworked PR to move structured logging handler from global to client/client pool. Awaiting review. Working on adding server selection logging. What goals are we targeting for the next two weeks? Add logging to other components (SDAM, server selection) Reasons for delays Removed global logging after comparing other language logging implementations. Test runner workarounds needed for single-threaded C driver to pass server selection tests. ----  2024-11-22: What was accomplished since the last update? Structured logging in review. Passes tests from CLAM spec. What goals are we targeting for the next two weeks? Add logging to other components (SDAM, server selection)
    • 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

      Summary

      What is the problem or use case, what are we trying to achieve?

      Motivation

      Who is the affected end user?

      Who are the stakeholders?

      How does this affect the end user?

      Are they blocked? Are they annoyed? Are they confused?

      How likely is it that this problem or use case will occur?

      Main path? Edge case?

      If the problem does occur, what are the consequences and how severe are they?

      Minor annoyance at a log message? Performance concern? Outage/unavailability? Failover can't complete?

      Is this issue urgent?

      Does this ticket have a required timeline? What is it?

      Is this ticket required by a downstream team?

      Needed by e.g. Atlas, Shell, Compass?

      Is this ticket only for tests?

      Is this ticket have any functional impact, or is it just test improvements?

      Cast of Characters

      Engineering Lead:
      Document Author:
      POCers:
      Product Owner:
      Program Manager:
      Stakeholders:

      Channels & Docs

      Slack Channel

      [Scope Document|some.url]

      [Technical Design Document|some.url]

            Assignee:
            micah.scott@mongodb.com Micah Scott
            Reporter:
            esha.bhargava@mongodb.com Esha Bhargava
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated:
              10 weeks, 4 days