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

Update SDAM spec to include error messages for electionId/setVersion mismatches

XMLWordPrintableJSON

    • Type: Icon: Spec Change Spec Change
    • Resolution: Unresolved
    • Priority: Icon: Unknown Unknown
    • None
    • Component/s: SDAM
    • None
    • Needed
    • Hide

      Summary of necessary driver changes

      • Add error message to server description when a primary goes stale
      • Add error field to ServerDescription in SDAM test runner

      Commits for syncing spec/prose tests
      (and/or refer to an existing language POC if needed)

      Context for other referenced/linked tickets

      • N/A
      Show
      Summary of necessary driver changes Add error message to server description when a primary goes stale Add error field to ServerDescription in SDAM test runner Commits for syncing spec/prose tests (and/or refer to an existing language POC if needed) https://github.com/mongodb/specifications/pull/1729   Context for other referenced/linked tickets N/A
    • $i18n.getText("admin.common.words.hide")
      Key Status/Resolution FixVersion
      CDRIVER-5805 Backlog
      CXX-3177 Backlog
      CSHARP-5407 Ready for Work
      GODRIVER-3423 Backlog
      JAVA-5697 Backlog
      NODE-6529 Fixed 6.14.0
      MOTOR-1411 Duplicate
      PYTHON-4960 Fixed 4.12
      PHPLIB-1590 Won't Do
      RUBY-3592 Backlog
      RUST-2095 Backlog
      $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 */ } #scriptField td.willNotDo { background-color: #FF0000; /* Red color code */ } /* Center-align the first row headers */ #scriptField th { text-align: center; } Key Status/Resolution FixVersion CDRIVER-5805 Backlog CXX-3177 Backlog CSHARP-5407 Ready for Work GODRIVER-3423 Backlog JAVA-5697 Backlog NODE-6529 Fixed 6.14.0 MOTOR-1411 Duplicate PYTHON-4960 Fixed 4.12 PHPLIB-1590 Won't Do RUBY-3592 Backlog RUST-2095 Backlog

      Summary

      According to the Server Discovery and Monitoring (SDAM) specification, the drivers update the topology with a default ServerDescription that has an UNKNOWN status and an empty error field when a stale primary is detected. We could include a descriptive error message in the ServerDescription.error field to enhance diagnostic capabilities in environments and it seems, at first glance, to be a low-effort improvement. This improvement was initially discussed in the HELP-63892 ticket where the proposal arose.

      Motivation

      Who is the affected end user?

      Tech support, and users.

      How does this affect the end user?

      Users might face confusion when drivers cannot connect to the cluster due to potential electionId/setVersion mismatches, especially in environments where logging is not enabled. This lack of clarity can lead to troubleshooting delays.

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

      The issue might not occur frequently, as judged by the rate of reported issues.

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

      If the problem occurs, it may lead to delays in troubleshooting.

      Is this issue urgent?

      Not urgent

      Acceptance Criteria

      Update SDAM specification to clearly define the new error message for electionId/setVersion mismatches in the ServerDescription.error field.

            Assignee:
            warren.james@mongodb.com Warren James
            Reporter:
            slav.babanin@mongodb.com Slav Babanin
            Shane Harvey Shane Harvey
            Tom Selander Tom Selander
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated: