[DRIVERS-2421] Drivers should include topology description in server selection timeout errors Created: 19/Aug/22  Updated: 21/Aug/23

Status: Implementing
Project: Drivers
Component/s: Server Selection
Fix Version/s: None

Type: Improvement Priority: Major - P3
Reporter: Kaitlin Mahar Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
Issue split
split to CXX-2675 Drivers should include topology descr... Backlog
split to PHPC-2254 Drivers should include topology descr... Blocked
split to CDRIVER-4614 Drivers should include topology descr... In Code Review
split to CSHARP-4613 Drivers should include topology descr... Closed
split to GODRIVER-2809 Drivers should include topology descr... Closed
split to JAVA-4935 Drivers should include topology descr... Closed
split to MOTOR-1119 Drivers should include topology descr... Closed
split to NODE-5196 Drivers should include topology descr... Closed
split to PYTHON-3667 Drivers should include topology descr... Closed
split to RUBY-3240 Drivers should include topology descr... Closed
split to RUST-1630 Drivers should include topology descr... Closed
Related
related to GODRIVER-559 Improve server selection error messag... Closed
related to GODRIVER-733 Add diagnostic information to server ... Closed
related to PYTHON-2136 Provide diagnostic information in Ser... Closed
related to RUST-268 Improve server selection error messages Closed
Driver Changes: Needed
Quarter: FY24Q2
Downstream Changes Summary:

NA

Start date:
Driver Compliance:
Key Status/Resolution FixVersion
CDRIVER-4614 In Code Review
CXX-2675 Backlog
CSHARP-4613 Works as Designed
GODRIVER-2809 Done
JAVA-4935 Works as Designed
NODE-5196 Works as Designed
MOTOR-1119 Duplicate
PYTHON-3667 Duplicate 3.11
PHPC-2254 Blocked
RUBY-3240 Works as Designed
RUST-1630 Works as Designed

 Description   

Summary

Drivers that do not already include the topology description in server selection timeout error messages should do so. Some drivers do this already, e.g. Python (see PYTHON-2136) and Ruby, and have found it useful.

Motivation

Who is the affected end user?

Users who are encountering server selection timeout errors.

How does this affect the end user?

Currently it can be hard for them or us to tell what the driver's view of their topology is, making it hard to diagnose why server selection is failing.

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

This is likely to impact anyone who is encountering server selection timeout errors, which are fairly common. Users often encounter these while trying to connect to a new cluster, write a new application, when their cluster gets in an unhealthy state, etc.

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

The user has difficulty debugging and fixing the problem.

Is this issue urgent?

No.

Is this ticket required by a downstream team?

No, but it would help users of downstream tools like mongosh if the Node driver doesn't include this information already.

Is this ticket only for tests?

No, functional changes are needed.


Generated at Thu Feb 08 08:25:32 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.