Skip to content
This repository was archived by the owner on May 1, 2025. It is now read-only.

DOCSP-48421-clarify-verifier-lag-time #673

Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions source/includes/api/tables/progress-response.rst
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,12 @@
writes on the source cluster. The time difference becomes zero
when ``mongosync`` commits the migration.

With the introduction of the :ref:`embdedded verfier<c2c-embedded-verifier>`
in version 1.9, there are now three different ``lagTimeSeconds`` fields:
- ``lagTimeSeconds`` for ``mongosync``
- ``lagTimeSeconds`` for the source cluster for the verifier
- ``lagTimeSeconds`` for the destination cluster for the verifier
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should probably specify that there are 3 fields when embedded verification is enabled. Otherwise, there's just one.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @autarch , update made! Back to you.


* - ``totalEventsApplied``
- integer
- The approximate number of change events this instance of
Expand Down
7 changes: 6 additions & 1 deletion source/reference/api/commit.txt
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,9 @@ Before using the ``commit`` endpoint:
- Use the :ref:`progress <c2c-api-progress>` endpoint to confirm the
following values:

- ``lagTimeSeconds`` is near ``0`` (*Recommended, but not required*)
- ``lagTimeSeconds`` for ``mongosync``, the source cluster
for the verifier, and the destination cluster for the
verifier are all near ``0`` (*Recommended, but not required*)

.. note:: lagTimeSeconds

Expand All @@ -49,6 +51,9 @@ Before using the ``commit`` endpoint:
When ``lagTimeSeconds`` is ``0``, the source and destination
clusters are in a consistent state.

For more information on the ``lagTimeSeconds`` fields, see
:ref:`c2c-api-progress`.

- ``state: "RUNNING"``
- ``canCommit: true``

Expand Down