DOCSP 30174 clarifying estimatedCopiedByes and estimatedTotalBytes #268
Conversation
jocelyn-mendez1
left a comment
jocelyn-mendez1
left a comment
There was a problem hiding this comment.
Thank you @ltran-mdb2! This LGTM!
| ``mongosync`` approximates the estimated number of copied bytes | ||
| prior to migration and does not update this value during the | ||
| synchronization process. This value does not reflect changes | ||
| made to the source cluster during sync and is not an accurate | ||
| indicator of migration progress. |
There was a problem hiding this comment.
This should say something like:
This value only reflects the bytes copied by the current instance of mongosync. The value does not reflect bytes copied by other instances of mongosync and can become larger than estimatedTotalBytes due to retried operations. This value is not an accurate indicator of migration progress.
There was a problem hiding this comment.
Thanks for your feedback! I added a line about the value comparison. Regarding "This value only reflects the bytes copied by the current instance of mongosync", the table item already states that the value is only the number of bytes copied by this mongosync." I'm hesitant to restate this due to redundancy but do you think this aspect needs to be emphasized more than it currently is?
There was a problem hiding this comment.
Ahh apologies, I didn't see that the top part of the description for estimatedCopiedBytes. Then there is no need to restate "This value only reflects the bytes copied by the current instance of mongosync".
But the following section is incorrect and should be removed. mongosync does in fact compute the estimated number of copied bytes during the migration by adding up the size of documents that it copies. This value will reflect changes made to the source cluster during sync and can be higher than estimatedTotalBytes if documents are added to the source or lower if documents are deleted from the source.
mongosync approximates the estimated number of copied bytes
prior to migration and does not update this value during the
synchronization process. This value does not reflect changes
made to the source cluster during sync and is not an accurate
indicator of migration progress.
There was a problem hiding this comment.
no worries, just made your suggested change!
…ongodb#268) * DOCSP-30174 clarifying estimatedCopiedByes and estimatedTotalBytes * DOCSP-30174 clarifying estimatedCopiedByes and estimatedTotalBytes * DOCSP-30174 clarifying estimatedCopiedByes and estimatedTotalBytes * DOCSP-30174 clarifying estimatedCopiedByes and estimatedTotalBytes * DOCSP-30174 tech edit * DOCSP-30174 tech edit * DOCSP-30174 tech edits * DOCSP-30174 tech edits
) (#270) * DOCSP-30174 clarifying estimatedCopiedByes and estimatedTotalBytes * DOCSP-30174 clarifying estimatedCopiedByes and estimatedTotalBytes * DOCSP-30174 clarifying estimatedCopiedByes and estimatedTotalBytes * DOCSP-30174 clarifying estimatedCopiedByes and estimatedTotalBytes * DOCSP-30174 tech edit * DOCSP-30174 tech edit * DOCSP-30174 tech edits * DOCSP-30174 tech edits
3 participants
DESCRIPTION
clarifying that estimatedCopiedByes and estimatedTotalBytes are approximated before migration and should not be used as an indicator of progress.
STAGING
https://preview-mongodbltranmdb2.gatsbyjs.io/cluster-sync/DOCSP-30174/reference/api/progress/#successful-response
JIRA
https://jira.mongodb.org/browse/DOCSP-30174
BUILD LOG
https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=65d7783e7111165982411eb5
SELF-REVIEW CHECKLIST
See the taxonomy tagging instructions and this example PR
EXTERNAL REVIEW REQUIREMENTS
What's expected of an external reviewer?