[SERVER-58432] Include dochub link in log line 5578800 when warning about deprecation/removal of old op codes Created: 12/Jul/21 Updated: 29/Oct/23 Resolved: 02/Aug/21 |
|
| Status: | Closed |
| Project: | Core Server |
| Component/s: | None |
| Affects Version/s: | None |
| Fix Version/s: | 5.0.3, 5.1.0-rc0 |
| Type: | Improvement | Priority: | Major - P3 |
| Reporter: | David Storch | Assignee: | Yoon Soo Kim |
| Resolution: | Fixed | Votes: | 0 |
| Labels: | None | ||
| Remaining Estimate: | Not Specified | ||
| Time Spent: | Not Specified | ||
| Original Estimate: | Not Specified | ||
| Issue Links: |
|
||||||||||||||||||||||||
| Backwards Compatibility: | Fully Compatible | ||||||||||||||||||||||||
| Backport Requested: |
v5.0
|
||||||||||||||||||||||||
| Sprint: | QE 2021-08-09 | ||||||||||||||||||||||||
| Participants: | |||||||||||||||||||||||||
| Description |
|
In We should improve log message 5578800 in both the master and 5.0 branches to include a dochub link. This link should redirect to a page that explains the deprecation and removal of the old op codes, and also provides instructions regarding what the customer should do in order to avoid any disruption to their application. |
| Comments |
| Comment by Vivian Ge (Inactive) [ 06/Oct/21 ] |
|
Updating the fixversion since branching activities occurred yesterday. This ticket will be in rc0 when it’s been triggered. For more active release information, please keep an eye on #server-release. Thank you! |
| Comment by Yoon Soo Kim [ 05/Aug/21 ] |
|
As suggested in the description. this dochub link change should be ported to v5.0 so that admins or customers may easily get the related information about legacy op code issue. |
| Comment by Jeffrey Allen [ 16/Jul/21 ] |
|
david.storch: https://dochub.mongodb.org/core/legacy-opcode-compatibility |
| Comment by David Storch [ 16/Jul/21 ] |
|
Yep, sounds great! Could you share the dochub link here when it is created? |
| Comment by Jeffrey Allen [ 16/Jul/21 ] |
|
david.storch, we could link to the compatibility notes since that blurb mentions upgrading to 5.0-compatible drivers. See this entry. From there, users have easy access to the main wire protocol page and OP_MSG docs entry. Does that make sense to you? |
| Comment by David Storch [ 16/Jul/21 ] |
|
jeffrey.allen would the dochub link point to the op codes reference page or to the release notes? The pointed-to page should say something like "please upgrade to 5.0 compatible drivers to avoid disruption" and should explain that the deprecation took place in 5.0.0 and the deletion in 5.1.0. I suppose we could also add something like this to the op codes reference page itself? |
| Comment by Jeffrey Allen [ 12/Jul/21 ] |
|
Hey david.storch, yes I think it makes sense to include the link to the docs alongside the Server warning. Would you like us to create a dochub link for the wire protocol page? The updates to reflect the legacy opcodes will be published on July 13th. |
| Comment by David Storch [ 12/Jul/21 ] |
|
jeffrey.allen andrew.feierabend I'd be curious if you think that this is worth doing from the docs perspective. This could make it easier for users to discover the relevant documentation if they encounter this warning in the logs. |